feat: Print a warning when both I18nProvider and own i18n string are missing #3172
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -98,10 +98,12 @@ const Cards = React.forwardRef(function <T = any>( | |
| selectionType, | ||
| isItemDisabled, | ||
| onSelectionChange, | ||
| ariaLabels: selectionType | ||
| ? { | ||
| itemSelectionLabel: ariaLabels?.itemSelectionLabel, | ||
| selectionGroupLabel: i18n('ariaLabels.selectionGroupLabel', ariaLabels?.selectionGroupLabel), | ||
| } | ||
| : {}, | ||
| }); | ||
| const hasToolsHeader = header || filter || pagination || preferences; | ||
| const hasFooterPagination = isMobile && variant === 'full-page' && !!pagination; | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -35,7 +35,7 @@ export default function InternalForm({ | |
| }: InternalFormProps) { | ||
| const baseProps = getBaseProps(props); | ||
| const i18n = useInternalI18n('form'); | ||
| const errorIconAriaLabel = errorText ? i18n('errorIconAriaLabel', errorIconAriaLabelOverride) : undefined; | ||
| const analyticsComponentMetadata: GeneratedAnalyticsMetadataFormFragment = { | ||
| component: { | ||
| name: 'awsui.Form', | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,8 +4,20 @@ | |
| import React from 'react'; | ||
| import { render } from '@testing-library/react'; | ||
|
|
||
| import { clearMessageCache } from '@cloudscape-design/component-toolkit/internal/testing'; | ||
|
|
||
| import { I18nProvider, I18nProviderProps } from '../../../lib/components/i18n'; | ||
| import { MESSAGES, SimpleTestComponent, TestComponent } from './test-component'; | ||
|
|
||
| beforeEach(() => { | ||
| clearMessageCache(); | ||
| jest.spyOn(console, 'warn').mockImplementation(() => {}); | ||
| }); | ||
|
|
||
| afterEach(() => { | ||
| expect(console.warn).not.toHaveBeenCalled(); | ||
| jest.restoreAllMocks(); | ||
| }); | ||
|
|
||
| describe('with custom "lang" on <html>', () => { | ||
| afterEach(() => { | ||
|
|
@@ -145,3 +157,10 @@ it('allows nesting providers', () => { | |
| expect(container.querySelector('#top-level-string')).toHaveTextContent('My custom string'); | ||
| expect(container.querySelector('#nested-string')).toHaveTextContent('nested string'); | ||
| }); | ||
|
|
||
| it('prints a warning when a string is not provided neither via prop nor I18nProvider', () => { | ||
| render(<SimpleTestComponent />); | ||
| expect(console.warn).toHaveBeenCalledTimes(1); | ||
| expect(console.warn).toHaveBeenCalledWith(expect.stringMatching(/topLevelString.*I18nProvider/)); | ||
| jest.mocked(console.warn).mockReset(); | ||
| }); | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -60,3 +60,9 @@ export function TestComponent(props: TestComponentProps) { | |
| </ul> | ||
| ); | ||
| } | ||
|
|
||
| export function SimpleTestComponent(props: TestComponentProps) { | ||
| const i18n = useInternalI18n('test-component'); | ||
|
|
||
| return <span id="top-level-string">{i18n('topLevelString', props.topLevelString)}</span>; | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -3,6 +3,9 @@ | |
|
|
||
| import React, { useContext } from 'react'; | ||
|
|
||
| import { warnOnce } from '@cloudscape-design/component-toolkit/internal'; | ||
|
|
||
| import { isDevelopment } from '../internal/is-development'; | ||
| import { I18nFormatArgTypes } from './messages-types'; | ||
|
|
||
| export type CustomHandler<ReturnValue, FormatFnArgs> = (formatFn: (args: FormatFnArgs) => string) => ReturnValue; | ||
|
|
@@ -20,7 +23,15 @@ interface InternalI18nContextProps { | |
|
|
||
| export const InternalI18nContext = React.createContext<InternalI18nContextProps>({ | ||
| locale: null, | ||
| format: <T>(_namespace: string, component: string, key: string, provided: T) => { | ||
| if (isDevelopment && !provided) { | ||
| warnOnce( | ||
| component, | ||
| `Localization is not provided for key ${key}. Provide the value as a prop or use I18nProvider` | ||
| ); | ||
|
Comment on lines
+28
to
+31
There was a problem hiding this comment. This is the change. Everything else is to fix appeared warnings |
||
| } | ||
| return provided; | ||
| }, | ||
| }); | ||
|
|
||
| export function useLocale(): string | null { | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -12,7 +12,7 @@ import styles from './styles.css.js'; | |
|
|
||
| export { DropdownStatusProps }; | ||
|
|
||
| export interface DropdownStatusPropsExtended extends Omit<DropdownStatusProps, 'recoveryText' | 'errorIconAriaLabel'> { | ||
| isEmpty?: boolean; | ||
| isNoMatch?: boolean; | ||
| isFiltered?: boolean; | ||
|
|
@@ -30,27 +30,16 @@ export interface DropdownStatusPropsExtended extends DropdownStatusProps { | |
| * in case recoveryText was automatically provided by i18n. | ||
| */ | ||
| hasRecoveryCallback?: boolean; | ||
|
|
||
| getErrorIconAriaLabel: () => string | undefined; | ||
| getRecoveryText: () => string | undefined; | ||
| } | ||
|
|
||
| function DropdownStatus({ children }: { children: React.ReactNode }) { | ||
| return <div className={styles.root}>{children}</div>; | ||
| } | ||
|
|
||
|
Comment on lines
-40
to
-52
There was a problem hiding this comment. There is no point to destructure the object in a type declaration |
||
| type UseDropdownStatus = (statusProps: DropdownStatusPropsExtended) => DropdownStatusResult; | ||
|
|
||
| export interface DropdownStatusResult { | ||
| isSticky: boolean; | ||
|
|
@@ -65,29 +54,30 @@ export const useDropdownStatus: UseDropdownStatus = ({ | |
| finishedText, | ||
| filteringResultsText, | ||
| errorText, | ||
| getRecoveryText, | ||
| isEmpty, | ||
| isNoMatch, | ||
| isFiltered, | ||
| noMatch, | ||
| onRecoveryClick, | ||
| hasRecoveryCallback = false, | ||
| getErrorIconAriaLabel, | ||
| }): DropdownStatusResult => { | ||
| const previousStatusType = usePrevious(statusType); | ||
| const statusResult: DropdownStatusResult = { isSticky: true, content: null, hasRecoveryButton: false }; | ||
|
|
||
| if (statusType === 'loading') { | ||
| statusResult.content = <InternalStatusIndicator type={'loading'}>{loadingText}</InternalStatusIndicator>; | ||
| } else if (statusType === 'error') { | ||
| const recoveryText = getRecoveryText(); | ||
| statusResult.hasRecoveryButton = !!recoveryText && hasRecoveryCallback; | ||
| statusResult.content = ( | ||
| <span> | ||
| <InternalStatusIndicator | ||
| type="error" | ||
| __display="inline" | ||
| __animate={previousStatusType !== 'error'} | ||
| iconAriaLabel={getErrorIconAriaLabel()} | ||
| > | ||
| {errorText} | ||
| </InternalStatusIndicator>{' '} | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -180,7 +180,7 @@ const InternalLink = React.forwardRef( | |
| sharedProps['aria-labelledby'] = `${sharedProps.id} ${infoId} ${infoLinkLabelFromContext}`; | ||
| } | ||
|
|
||
| const renderedExternalIconAriaLabel = external ? i18n('externalIconAriaLabel', externalIconAriaLabel) : undefined; | ||
| const content = ( | ||
| <> | ||
| {children} | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -44,7 +44,6 @@ const EmbeddedMultiselect = React.forwardRef( | |
| filteringType, | ||
| ariaLabel, | ||
| selectedOptions, | ||
| virtualScroll, | ||
| filteringText = '', | ||
| ...restProps | ||
|
|
@@ -58,8 +57,6 @@ const EmbeddedMultiselect = React.forwardRef( | |
| options, | ||
| selectedOptions, | ||
| filteringType, | ||
| controlId: formFieldContext.controlId, | ||
| ariaLabelId, | ||
| footerId, | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -73,8 +73,6 @@ const InternalMultiselect = React.forwardRef( | |
| options, | ||
| selectedOptions, | ||
| filteringType, | ||
| controlId, | ||
| ariaLabelId, | ||
| footerId, | ||
|
|
@@ -122,9 +120,11 @@ const InternalMultiselect = React.forwardRef( | |
| iconUrl: option.iconUrl, | ||
| iconSvg: option.iconSvg, | ||
| tags: option.tags, | ||
| dismissLabel: hideTokens | ||
| ? undefined | ||
| : i18n('deselectAriaLabel', deselectAriaLabel?.(option), format => | ||
| format({ option__label: option.label ?? '' }) | ||
| ), | ||
| })); | ||
|
|
||
| const ListComponent = virtualScroll ? VirtualList : PlainList; | ||
|
|
||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Make recovery text and error label lazy-loadable, only when this feature is used