diff --git a/src/data/installationFeedback.js b/src/data/installationFeedback.js index 13e92c8b99..4dc1858ddf 100644 --- a/src/data/installationFeedback.js +++ b/src/data/installationFeedback.js @@ -1,6 +1,6 @@ import { msg } from '../i18n/marker.js'; -// layers/installations/controls.js translates describeInstallationFeedback(). +// installationFeedback() is English data; ui/statusText.js shows it translated. const REASONS = Object.freeze({ rate_limited: msg('Overpass rate-limited'), timeout: msg('Overpass timed out'), diff --git a/src/layers/installations/controls.js b/src/layers/installations/controls.js index 2fa31e59ef..608d6efbfc 100644 --- a/src/layers/installations/controls.js +++ b/src/layers/installations/controls.js @@ -1,37 +1,11 @@ import * as Cesium from 'cesium'; -import { describeInstallationFeedback } from '../../data/installationFeedback.js'; +import { installationFeedback } from '../../data/installationFeedback.js'; import { LAYER_ID, DISTANCE_PREFILTER_MARGIN_M, ANCHOR_REFRESH_M, } from './policy.js'; -import { formatNumber, t, tn } from '../../i18n/index.js'; - -// installationFeedback.js is shared with the HUD (src/loadingFeedback.js) and -// hands back msg()-marked English plus values; getStats translates them here. -function localizeInstallationFeedback(feedback) { - if (feedback.text !== undefined) { - const values = {}; - if (feedback.reason !== undefined) values.reason = t(feedback.reason); - if (feedback.seconds !== undefined) values.seconds = feedback.seconds; - return t(feedback.text, values); - } - const { count, km } = feedback; - if (km) { - const kmText = formatNumber(km); - return count === 0 - ? t('No mapped sites within {km} km of the contact', { km: kmText }) - : tn( - count, - '{count} mapped site within {km} km of the contact', - '{count} mapped sites within {km} km of the contact', - { km: kmText }, - ); - } - return count === 0 - ? t('No mapped sites in view') - : tn(count, '{count} mapped site in view', '{count} mapped sites in view'); -} +import { t } from '../../i18n/index.js'; export function createControls({ state: layerState, services, parts, source }) { const methods = { @@ -252,13 +226,13 @@ export function createControls({ state: layerState, services, parts, source }) { retryAt: layerState.retryAt, retrying: layerState.loading && Boolean(layerState.failureReason), failureReason: layerState.failureReason, - statusMessage: localizeInstallationFeedback( - describeInstallationFeedback({ - ...layerState, - count: layerState.lastUpdate ? mappedCount : undefined, - retrying: layerState.loading && Boolean(layerState.failureReason), - }), - ), + // English data: it is also the analyst's empty note to the model. + // Displays translate it by its shape (ui/statusText.js). + statusMessage: installationFeedback({ + ...layerState, + count: layerState.lastUpdate ? mappedCount : undefined, + retrying: layerState.loading && Boolean(layerState.failureReason), + }), loadingLabel: layerState.loading ? t('loading mapped installation context') : '', diff --git a/src/layers/installations/installationFeedbackLocale.test.mjs b/src/layers/installations/installationFeedbackLocale.test.mjs index cf4e758a33..7dac443510 100644 --- a/src/layers/installations/installationFeedbackLocale.test.mjs +++ b/src/layers/installations/installationFeedbackLocale.test.mjs @@ -1,6 +1,10 @@ +// getStats().statusMessage is English data (it is also the analyst's empty +// note to the model); the displays show it in the UI language through +// translateStatusPiece (ui/statusText.js). import test from 'node:test'; import assert from 'node:assert/strict'; -import { setLocale, translateKnown } from '../../i18n/index.js'; +import { setLocale, t, tn, translateKnown } from '../../i18n/index.js'; +import { translateStatusPiece } from '../../ui/statusText.js'; import { createControls } from './controls.js'; function stats(state) { @@ -13,67 +17,115 @@ function stats(state) { }).methods.getStats(); } -for (const locale of ['es', 'ru']) { - test(`${locale}: installation feedback is in the UI language`, () => { - setLocale(locale); - const empty = stats({ status: 'empty', lastUpdate: 1 }).statusMessage; - assert.notEqual(empty, 'No mapped sites in view'); - const found = stats({ +function inLocale(locale, run) { + setLocale(locale); + try { + run(); + } finally { + setLocale('en'); + } +} + +// Each layer state, the English statusMessage it reports, and how the UI +// shows it. A retry a minute out reads "60s" (rounded up). +const cases = [ + [ + { status: 'empty', lastUpdate: 1 }, + 'No mapped sites in view', + () => t('No mapped sites in view'), + ], + [ + { status: 'ready', lastUpdate: 1, records: [{ kind: 'installation' }, { kind: 'installation' }], - }).statusMessage; - assert.notEqual(found, '2 mapped sites in view'); - const tiles = stats({ - status: 'unavailable', - failureReason: 'tiles_unavailable', - }).statusMessage; - assert.notEqual(tiles, 'Map tiles temporarily unavailable'); - const retry = stats({ + }, + '2 mapped sites in view', + () => tn(2, '{count} mapped site in view', '{count} mapped sites in view'), + ], + [ + { + status: 'empty', + lastUpdate: 1, + wide: true, + coverage: { kind: 'subject', radiusM: 25000 }, + }, + 'No mapped sites within 25 km of the contact', + () => t('No mapped sites within {km} km of the contact', { km: '25' }), + ], + [ + { + status: 'ready', + lastUpdate: 1, + wide: true, + coverage: { kind: 'subject', radiusM: 25000 }, + records: [{ kind: 'installation' }], + }, + '1 mapped site within 25 km of the contact', + () => + tn( + 1, + '{count} mapped site within {km} km of the contact', + '{count} mapped sites within {km} km of the contact', + { km: '25' }, + ), + ], + [ + { status: 'unavailable', failureReason: 'tiles_unavailable' }, + 'Map tiles temporarily unavailable', + () => t('Map tiles temporarily unavailable'), + ], + [ + { status: 'unavailable', failureReason: 'names_unavailable', - retryAt: Date.now() + 5000, - }).statusMessage; - assert.doesNotMatch(retry, /^Mapped names temporarily unavailable/); - for (const text of [ - 'Too many mapped sites in view to list them all', - 'Installation context unavailable', - ]) { - assert.notEqual(translateKnown(text), text); - } + get retryAt() { + return Date.now() + 60_000; + }, + }, + 'Mapped names temporarily unavailable — retrying in 60s', + () => + t('{reason} — retrying in {seconds}s', { + reason: t('Mapped names temporarily unavailable'), + seconds: 60, + }), + ], + [ + { status: 'zoom-in' }, + 'Zoom in to search mapped installations', + () => t('Zoom in to search mapped installations'), + ], +]; + +for (const locale of ['es', 'ru']) { + test(`${locale}: installation statusMessage stays English data`, () => { + inLocale(locale, () => { + for (const [state, english] of cases) + assert.equal(stats(state).statusMessage, english); + }); + }); + + test(`${locale}: installation statusMessage is shown in the UI language`, () => { + inLocale(locale, () => { + for (const [state, english, shown] of cases) { + const shownText = translateStatusPiece(stats(state).statusMessage); + assert.notEqual(shownText, english); + assert.equal(shownText, shown()); + } + for (const text of [ + 'Too many mapped sites in view to list them all', + 'Installation context unavailable', + ]) { + assert.notEqual(translateKnown(text), text); + } + }); }); } test('en: installation feedback keeps its English wording', () => { setLocale('en'); - assert.equal( - stats({ status: 'empty', lastUpdate: 1 }).statusMessage, - 'No mapped sites in view', - ); - assert.equal( - stats({ - status: 'ready', - lastUpdate: 1, - records: [{ kind: 'installation' }], - }).statusMessage, - '1 mapped site in view', - ); - assert.equal( - stats({ - status: 'ready', - lastUpdate: 1, - wide: true, - coverage: { kind: 'subject', radiusM: 25000 }, - records: [{ kind: 'installation' }, { kind: 'installation' }], - }).statusMessage, - '2 mapped sites within 25 km of the contact', - ); - assert.equal( - stats({ - status: 'unavailable', - failureReason: 'names_unavailable', - retryAt: Date.now() + 5000, - }).statusMessage, - 'Mapped names temporarily unavailable — retrying in 5s', - ); + for (const [state, english] of cases) { + assert.equal(stats(state).statusMessage, english); + assert.equal(translateStatusPiece(english), english); + } });