Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Report missing en locale messages to Sentry #7197

Merged
merged 1 commit into from
Sep 21, 2019
Merged

Report missing en locale messages to Sentry #7197

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 6 additions & 7 deletions ui/app/helpers/higher-order-components/i18n-provider.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,15 @@ const connect = require('react-redux').connect
const PropTypes = require('prop-types')
const { withRouter } = require('react-router-dom')
const { compose } = require('recompose')
const t = require('../utils/i18n-helper').getMessage
const { getMessage } = require('../utils/i18n-helper')

class I18nProvider extends Component {
tOrDefault = (key, defaultValue, ...args) => {
if (!key) {
return defaultValue
}
const { localeMessages: { current, en } = {}, currentLocale } = this.props
return t(currentLocale, current, key, ...args) || t(currentLocale, en, key, ...args) || defaultValue
return getMessage(currentLocale, current, key, ...args) || getMessage(currentLocale, en, key, ...args) || defaultValue
}

getChildContext () {
Expand All @@ -22,11 +25,7 @@ class I18nProvider extends Component {
* @return {string|undefined|null} The localized message if available
*/
t (key, ...args) {
if (key === undefined || key === null) {
return key
}

return t(currentLocale, current, key, ...args) || t(currentLocale, en, key, ...args) || `[${key}]`
return getMessage(currentLocale, current, key, ...args) || getMessage(currentLocale, en, key, ...args) || `[${key}]`
},
tOrDefault: this.tOrDefault,
tOrKey: (key, ...args) => {
Expand Down
22 changes: 15 additions & 7 deletions ui/app/helpers/utils/i18n-helper.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
// cross-browser connection to extension i18n API
const log = require('loglevel')
const Sentry = require('@sentry/browser')

const warned = {}
const missingMessageErrors = {}

/**
* Returns a localized message for the given key
* @param {string} localeCode The code for the current locale
Expand All @@ -10,12 +13,21 @@ const warned = {}
* @param {string[]} substitutions A list of message substitution replacements
* @return {null|string} The localized message
*/
const getMessage = (localeCode, localeMessages, key, substitutions) => {
export const getMessage = (localeCode, localeMessages, key, substitutions) => {
if (!localeMessages) {
return null
}
if (!localeMessages[key]) {
if (!warned[localeCode] || !warned[localeCode][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] = {}
}
Expand All @@ -36,7 +48,7 @@ const getMessage = (localeCode, localeMessages, key, substitutions) => {
return phrase
}

async function fetchLocale (localeCode) {
export async function fetchLocale (localeCode) {
try {
const response = await fetch(`./_locales/${localeCode}/messages.json`)
return await response.json()
Expand All @@ -46,7 +58,3 @@ async function fetchLocale (localeCode) {
}
}

module.exports = {
getMessage,
fetchLocale,
}