Skip to content

Commit a9f6add

Browse files
committed
fix(i18n): follow language changes safely in desktop windows, plural waiting count (TM-286)
1 parent 872f69e commit a9f6add

20 files changed

Lines changed: 137 additions & 36 deletions

File tree

‎src/decisions-phones/App.vue‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,11 @@
1515
:alt="$t('decisions.phones.qrAlt')"
1616
/>
1717
<p class="muted">
18-
{{ $t('decisions.phones.expiresIn') }}
19-
<strong data-test="countdown">{{ countdown }}</strong>
18+
<i18n-t keypath="decisions.phones.expiresInTime" scope="global">
19+
<template #time>
20+
<strong data-test="countdown">{{ countdown }}</strong>
21+
</template>
22+
</i18n-t>
2023
</p>
2124
</template>
2225
<form

‎src/decisions-phones/main.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ followStoredLocale();
1616

1717
void setLocale(
1818
detectLocale({ stored: storedLocale(), browser: navigator.languages ?? [] }),
19+
{ persist: false },
1920
)
2021
.catch(() => undefined)
2122
.then(() => createApp(App).use(i18n).mount('#root'));

‎src/decisions/components/App.vue‎

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -154,9 +154,7 @@
154154
>
155155
</div>
156156
<span class="dot"></span>
157-
<span>{{
158-
$t('decisions.statusbar.waiting', { n: progress.pending })
159-
}}</span>
157+
<span>{{ $t('decisions.statusbar.waiting', progress.pending) }}</span>
160158
</footer>
161159
<div class="toast" :class="{ on: toast.on, error: toast.error }">
162160
<span>{{ toast.text }}</span>
@@ -173,7 +171,7 @@
173171
</template>
174172

175173
<script lang="ts">
176-
import { t } from '@/i18n';
174+
import { onLocaleChange, t } from '@/i18n';
177175
import { defineComponent } from 'vue';
178176
import {
179177
answerToast,
@@ -269,6 +267,7 @@
269267
toast: { on: false, error: false, text: '' },
270268
toastTimer: 0 as number,
271269
unlisten: null as null | (() => void),
270+
stopLocale: null as null | (() => void),
272271
refreshing: false,
273272
refreshAgain: false,
274273
isMac: /Mac/i.test(navigator.userAgent),
@@ -358,6 +357,9 @@
358357
async mounted() {
359358
window.addEventListener('keydown', this.onKeydown);
360359
document.title = t('decisions.window.title');
360+
this.stopLocale = onLocaleChange(() => {
361+
document.title = t('decisions.window.title');
362+
});
361363
this.openedAt = Date.now();
362364
let ticks = 0;
363365
this.clock = window.setInterval(() => {
@@ -379,6 +381,7 @@
379381
window.clearTimeout(this.doomModeTimer);
380382
window.clearInterval(this.clock);
381383
this.unlisten?.();
384+
this.stopLocale?.();
382385
},
383386
methods: {
384387
isFinal,

‎src/decisions/main.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ followStoredLocale();
2121

2222
void setLocale(
2323
detectLocale({ stored: storedLocale(), browser: navigator.languages ?? [] }),
24+
{ persist: false },
2425
)
2526
.catch(() => undefined)
2627
.then(() => createApp(App).use(i18n).mount('#root'));

‎src/i18n/__tests__/followStoredLocale.test.ts‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,18 @@
33
*/
44
import { currentLocale, LOCALE_STORAGE_KEY, setLocale } from '@/i18n';
55
import { followStoredLocale } from '../followStoredLocale';
6+
import * as catalog from '../messageCatalog.node';
67

78
const storageEvent = (key: string | null, newValue: string | null) =>
89
new StorageEvent('storage', { key, newValue });
910

11+
const flush = () => new Promise((resolve) => setTimeout(resolve, 20));
12+
1013
describe('followStoredLocale', () => {
1114
afterEach(async () => {
15+
jest.restoreAllMocks();
1216
await setLocale('en');
17+
localStorage.clear();
1318
});
1419

1520
it('switches to the locale written by another window', async () => {
@@ -35,4 +40,61 @@ describe('followStoredLocale', () => {
3540
await new Promise((resolve) => setTimeout(resolve, 0));
3641
expect(currentLocale()).toBe('en');
3742
});
43+
44+
it('does not write the followed locale back to storage', async () => {
45+
const stop = followStoredLocale();
46+
const setItem = jest.spyOn(Storage.prototype, 'setItem');
47+
window.dispatchEvent(storageEvent(LOCALE_STORAGE_KEY, 'ru'));
48+
await flush();
49+
expect(currentLocale()).toBe('ru');
50+
expect(setItem).not.toHaveBeenCalled();
51+
stop();
52+
});
53+
54+
it('normalizes regional tags and ignores unsupported or unchanged values', async () => {
55+
const stop = followStoredLocale();
56+
window.dispatchEvent(storageEvent(LOCALE_STORAGE_KEY, 'ru-RU'));
57+
await flush();
58+
expect(currentLocale()).toBe('ru');
59+
const setItem = jest.spyOn(Storage.prototype, 'setItem');
60+
window.dispatchEvent(storageEvent(LOCALE_STORAGE_KEY, 'xx'));
61+
window.dispatchEvent(storageEvent(LOCALE_STORAGE_KEY, 'ru'));
62+
await flush();
63+
expect(currentLocale()).toBe('ru');
64+
expect(setItem).not.toHaveBeenCalled();
65+
stop();
66+
});
67+
68+
it('keeps the newest locale when an older load resolves later', async () => {
69+
await setLocale('ru');
70+
const stop = followStoredLocale();
71+
let release: (value: any) => void = () => undefined;
72+
const realLoad = catalog.loadMessages;
73+
jest
74+
.spyOn(catalog, 'loadMessages')
75+
.mockImplementationOnce(
76+
() => new Promise((resolve) => (release = resolve)) as any,
77+
);
78+
window.dispatchEvent(storageEvent(LOCALE_STORAGE_KEY, 'ja'));
79+
window.dispatchEvent(storageEvent(LOCALE_STORAGE_KEY, 'en'));
80+
await flush();
81+
expect(currentLocale()).toBe('en');
82+
release(await realLoad('ja'));
83+
await flush();
84+
expect(currentLocale()).toBe('en');
85+
stop();
86+
});
87+
88+
it('swallows a failed catalog load', async () => {
89+
const stop = followStoredLocale();
90+
const unhandled = jest.fn();
91+
process.on('unhandledRejection', unhandled);
92+
jest.spyOn(catalog, 'loadMessages').mockRejectedValueOnce(new Error('x'));
93+
window.dispatchEvent(storageEvent(LOCALE_STORAGE_KEY, 'ko'));
94+
await flush();
95+
process.off('unhandledRejection', unhandled);
96+
expect(unhandled).not.toHaveBeenCalled();
97+
expect(currentLocale()).toBe('en');
98+
stop();
99+
});
38100
});

‎src/i18n/followStoredLocale.ts‎

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,16 @@
1-
import { LOCALE_STORAGE_KEY, setLocale } from '@/i18n';
1+
import {
2+
currentLocale,
3+
LOCALE_STORAGE_KEY,
4+
normalizeLocale,
5+
setLocale,
6+
} from '@/i18n';
27

38
export const followStoredLocale = (target: Window = window): (() => void) => {
49
const listener = (event: StorageEvent) => {
5-
if (event.key === LOCALE_STORAGE_KEY && event.newValue) {
6-
void setLocale(event.newValue);
7-
}
10+
if (event.key !== LOCALE_STORAGE_KEY) return;
11+
const next = normalizeLocale(event.newValue);
12+
if (!next || next === currentLocale()) return;
13+
setLocale(next, { persist: false }).catch(() => undefined);
814
};
915
target.addEventListener('storage', listener);
1016
return () => target.removeEventListener('storage', listener);

‎src/i18n/index.ts‎

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ export const currentLocale = (): LocaleCode =>
3737
i18n.global.locale.value as LocaleCode;
3838

3939
const loaded = new Set<LocaleCode>([DEFAULT_LOCALE]);
40+
let latestRequest = 0;
4041
const listeners = new Set<(locale: LocaleCode) => void>();
4142

4243
export const onLocaleChange = (listener: (locale: LocaleCode) => void) => {
@@ -52,19 +53,26 @@ export const storedLocale = (): string | null => {
5253
}
5354
};
5455

55-
export const setLocale = async (locale: unknown): Promise<LocaleCode> => {
56+
export const setLocale = async (
57+
locale: unknown,
58+
options: { persist?: boolean } = {},
59+
): Promise<LocaleCode> => {
5660
const next = isSupportedLocale(locale) ? locale : DEFAULT_LOCALE;
61+
const ticket = ++latestRequest;
5762
if (!loaded.has(next)) {
5863
i18n.global.setLocaleMessage(next, (await loadMessages(next)) as any);
5964
loaded.add(next);
6065
}
66+
if (ticket !== latestRequest) return currentLocale();
6167
const changed = next !== currentLocale();
6268
i18n.global.locale.value = next;
6369
if (typeof document !== 'undefined') document.documentElement.lang = next;
64-
try {
65-
localStorage.setItem(LOCALE_STORAGE_KEY, next);
66-
} catch {
67-
/* private mode */
70+
if (options.persist !== false) {
71+
try {
72+
localStorage.setItem(LOCALE_STORAGE_KEY, next);
73+
} catch {
74+
/* private mode */
75+
}
6876
}
6977
if (changed) {
7078
requestCache.clear();

‎src/locales/de/decisions.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@
9797
"defer": "zurückstellen",
9898
"dismiss": "verwerfen",
9999
"cards": "Karten",
100-
"waiting": "{n} wartend"
100+
"waiting": "{n} wartend | {n} wartend"
101101
},
102102
"queue": {
103103
"title": "Warteschlange",
@@ -184,7 +184,7 @@
184184
"phones": {
185185
"title": "tmgr · Telefone",
186186
"qrAlt": "QR-Code zum Koppeln",
187-
"expiresIn": "Läuft ab in",
187+
"expiresInTime": "Läuft ab in {time}",
188188
"typeCode": "Gib den Code ein, der auf deinem iPhone angezeigt wird",
189189
"confirm": "Bestätigen",
190190
"done": "Du kannst jetzt Entscheidungskarten vom Telefon aus beantworten.",

‎src/locales/en/decisions.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@
9797
"defer": "defer",
9898
"dismiss": "dismiss",
9999
"cards": "cards",
100-
"waiting": "{n} waiting"
100+
"waiting": "{n} waiting | {n} waiting"
101101
},
102102
"queue": {
103103
"title": "Queue",
@@ -184,7 +184,7 @@
184184
"phones": {
185185
"title": "tmgr · Phones",
186186
"qrAlt": "Pairing QR code",
187-
"expiresIn": "Expires in",
187+
"expiresInTime": "Expires in {time}",
188188
"typeCode": "Type the code shown on your iPhone",
189189
"confirm": "Confirm",
190190
"done": "You can answer Decisions cards from the phone now.",

‎src/locales/es/decisions.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@
9797
"defer": "aplazar",
9898
"dismiss": "descartar",
9999
"cards": "tarjetas",
100-
"waiting": "{n} en espera"
100+
"waiting": "{n} en espera | {n} en espera"
101101
},
102102
"queue": {
103103
"title": "Cola",
@@ -184,7 +184,7 @@
184184
"phones": {
185185
"title": "tmgr · Teléfonos",
186186
"qrAlt": "Código QR de emparejamiento",
187-
"expiresIn": "Caduca en",
187+
"expiresInTime": "Caduca en {time}",
188188
"typeCode": "Escribe el código que aparece en tu iPhone",
189189
"confirm": "Confirmar",
190190
"done": "Ya puedes responder tarjetas de Decisiones desde el teléfono.",

0 commit comments

Comments
 (0)