1
0
mirror of https://github.com/kremalicious/metamask-extension.git synced 2024-11-23 10:30:04 +01:00
metamask-extension/ui/app/helpers/utils/i18n-helper.js
Mark Stacey 564f76584b
Tolerate missing or falsey substitutions (#8907)
Previously the `getMessage` function would throw if a substitution was
falsey. Now it will accept any substitution, including `undefined`.

A substitution of `null` or `undefined` will still be reported to
Sentry and printed to the console as an error, but it will not
interrupt execution. Any `null` or `undefined` substitutions will be
rendered as empty strings.

Ideally we'd never pass in `null` or `undefined` as a substitution, but
in practice this sometimes just occurs breifly between renders, which
isn't a severe enough problem to justify crashing the UI.

The detection of React component substitutions has been updated as
well, to ensure that `null` values aren't counted as React
substitutions.
2020-07-03 13:02:35 -03:00

102 lines
3.3 KiB
JavaScript

// cross-browser connection to extension i18n API
import React from 'react'
import log from 'loglevel'
import * as Sentry from '@sentry/browser'
const warned = {}
const missingMessageErrors = {}
/**
* Returns a localized message for the given key
* @param {string} localeCode - The code for the current locale
* @param {Object} localeMessages - The map of messages for the current locale
* @param {string} key - The message key
* @param {string[]} substitutions - A list of message substitution replacements
* @returns {null|string} - The localized message
*/
export const getMessage = (localeCode, localeMessages, key, substitutions) => {
if (!localeMessages) {
return null
}
if (!localeMessages[key]) {
if (localeCode === 'en') {
if (!missingMessageErrors[key]) {
missingMessageErrors[key] = new Error(`Unable to find value of key "${key}" for locale "${localeCode}"`)
Sentry.captureException(missingMessageErrors[key])
log.error(missingMessageErrors[key])
if (process.env.IN_TEST === 'true') {
throw missingMessageErrors[key]
}
}
} else if (!warned[localeCode] || !warned[localeCode][key]) {
if (!warned[localeCode]) {
warned[localeCode] = {}
}
warned[localeCode][key] = true
log.warn(`Translator - Unable to find value of key "${key}" for locale "${localeCode}"`)
}
return null
}
const entry = localeMessages[key]
let phrase = entry.message
const hasSubstitutions = Boolean(substitutions && substitutions.length)
const hasReactSubstitutions = hasSubstitutions &&
substitutions.some((element) => element !== null && (typeof element === 'function' || typeof element === 'object'))
// perform substitutions
if (hasSubstitutions) {
const parts = phrase.split(/(\$\d)/g)
const substitutedParts = parts.map((part) => {
const subMatch = part.match(/\$(\d)/)
if (!subMatch) {
return part
}
const substituteIndex = Number(subMatch[1]) - 1
if (substitutions[substituteIndex] == null) {
const error = new Error(`Insufficient number of substitutions for message: '${phrase}'`)
log.error(error)
Sentry.captureException(error)
}
return substitutions[substituteIndex]
})
phrase = hasReactSubstitutions
? <span> { substitutedParts } </span>
: substitutedParts.join('')
}
return phrase
}
export async function fetchLocale (localeCode) {
try {
const response = await window.fetch(`./_locales/${localeCode}/messages.json`)
return await response.json()
} catch (error) {
log.error(`failed to fetch ${localeCode} locale because of ${error}`)
return {}
}
}
const relativeTimeFormatLocaleData = new Set()
export async function loadRelativeTimeFormatLocaleData (localeCode) {
const languageTag = localeCode.split('_')[0]
if (
Intl.RelativeTimeFormat &&
typeof Intl.RelativeTimeFormat.__addLocaleData === 'function' &&
!relativeTimeFormatLocaleData.has(languageTag)
) {
const localeData = await fetchRelativeTimeFormatData(languageTag)
Intl.RelativeTimeFormat.__addLocaleData(localeData)
}
}
async function fetchRelativeTimeFormatData (languageTag) {
const response = await window.fetch(`./intl/${languageTag}/relative-time-format-data.json`)
return await response.json()
}