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

fix: Improve error message for missing messages by including the locale #782

Merged
merged 2 commits into from
Jan 17, 2024
Merged

fix: Improve error message for missing messages by including the locale #782

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d8edfef
fix: Improve error message for missing messages by including the locale
amannn Jan 17, 2024
9e0c822
Change argument order
amannn Jan 17, 2024
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
37 changes: 18 additions & 19 deletions packages/use-intl/src/core/createBaseTranslator.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ import NestedKeyOf from './utils/NestedKeyOf';
import NestedValueOf from './utils/NestedValueOf';

function resolvePath(
locale: string,
messages: AbstractIntlMessages | undefined,
key: string,
namespace?: string
Expand All @@ -46,8 +47,8 @@ function resolvePath(
if (part == null || next == null) {
throw new Error(
process.env.NODE_ENV !== 'production'
? `Could not resolve \`${fullKey}\` in messages.`
: fullKey
? `Could not resolve \`${fullKey}\` in messages for locale \`${locale}\`.`
: fullKey + ` (${locale})`
);
}

Expand Down Expand Up @@ -85,15 +86,12 @@ function prepareTranslationValues(values: RichTranslationValues) {
return transformedValues;
}

function getMessagesOrError<Messages extends AbstractIntlMessages>({
messages,
namespace,
onError = defaultOnError
}: {
messages?: Messages;
namespace?: string;
onError?(error: IntlError): void;
}) {
function getMessagesOrError<Messages extends AbstractIntlMessages>(
locale: string,
messages?: Messages,
namespace?: string,
onError: (error: IntlError) => void = defaultOnError
) {
try {
if (!messages) {
throw new Error(
Expand All @@ -104,7 +102,7 @@ function getMessagesOrError<Messages extends AbstractIntlMessages>({
}

const retrievedMessages = namespace
? resolvePath(messages, namespace)
? resolvePath(locale, messages, namespace)
: messages;

if (!retrievedMessages) {
Expand Down Expand Up @@ -154,11 +152,12 @@ export default function createBaseTranslator<
Messages extends AbstractIntlMessages,
NestedKey extends NestedKeyOf<Messages>
>(config: Omit<CreateBaseTranslatorProps<Messages>, 'messagesOrError'>) {
const messagesOrError = getMessagesOrError({
messages: config.messages,
namespace: config.namespace,
onError: config.onError
}) as Messages | IntlError;
const messagesOrError = getMessagesOrError(
config.locale,
config.messages,
config.namespace,
config.onError
) as Messages | IntlError;

return createBaseTranslatorImpl<Messages, NestedKey>({
...config,
Expand Down Expand Up @@ -210,7 +209,7 @@ function createBaseTranslatorImpl<

let message;
try {
message = resolvePath(messages, key, namespace);
message = resolvePath(locale, messages, key, namespace);
} catch (error) {
return getFallbackFromErrorAndNotify(
key,
Expand Down Expand Up @@ -408,7 +407,7 @@ function createBaseTranslatorImpl<
const messages = messagesOrError;

try {
return resolvePath(messages, key, namespace);
return resolvePath(locale, messages, key, namespace);
} catch (error) {
return getFallbackFromErrorAndNotify(
key,
Expand Down
4 changes: 2 additions & 2 deletions packages/use-intl/test/react/useTranslations.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -583,7 +583,7 @@ describe('error handling', () => {

const error: IntlError = onError.mock.calls[0][0];
expect(error.message).toBe(
'MISSING_MESSAGE: Could not resolve `Component` in messages.'
'MISSING_MESSAGE: Could not resolve `Component` in messages for locale `en`.'
);
expect(error.code).toBe(IntlErrorCode.MISSING_MESSAGE);
screen.getByText('Component.label');
Expand All @@ -605,7 +605,7 @@ describe('error handling', () => {

const error: IntlError = onError.mock.calls[0][0];
expect(error.message).toBe(
'MISSING_MESSAGE: Could not resolve `Component.label` in messages.'
'MISSING_MESSAGE: Could not resolve `Component.label` in messages for locale `en`.'
);
expect(error.code).toBe(IntlErrorCode.MISSING_MESSAGE);
screen.getByText('Component.label');
Expand Down
Loading