[Accessibility Labels] Localise accessibility labels and update texts accordingly.

[Prince-Mendiratta]

Details

We currently only translate some accessibilityLabels and accessibilityHints in the App. This is due to us using them to query particular elements in automated testing. With this PR, those texts are localized according to user language and the tests make use of the translateLocal function to get the text value for anchoring to elements.

Fixed Issues

$ #14763
PROPOSAL: #14763 (comment)

Tests

For tests:

1. Run npm test locally.
2. Ensure all test cases pass.

Since the tests are working properly, it is implied implicitly that the accessibility labels are translated properly on the app as well. So no need to verify each and every label.

• Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

No QA needed

• Verify that no errors appear in the JS console

PR Author Checklist

• I linked the correct issue in the ### Fixed Issues section above
• I wrote clear testing steps that cover the changes made in this PR
  • I added steps for local testing in the Tests section
  • I added steps for the expected offline behavior in the Offline steps section
  • I added steps for Staging and/or Production testing in the QA steps section
  • I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
  • I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
  • I tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
• I included screenshots or videos for tests on all platforms
• I ran the tests on all platforms & verified they passed on:
  • Android / native
  • Android / Chrome
  • iOS / native
  • iOS / Safari
  • MacOS / Chrome / Safari
  • MacOS / Desktop
• I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
• I followed proper code patterns (see Reviewing the code)
  • I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick)
  • I verified that comments were added to code that is not self explanatory
  • I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
  • I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
    • If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message: https://expensify.slack.com/archives/C01GTK53T8Q/p1679927477520439
  • I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
  • I verified any copy / text that was added to the app is correct English and approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
  • I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
  • I verified the JSDocs style guidelines (in STYLE.md) were followed
• If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
• I followed the guidelines as stated in the Review Guidelines
• I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
• I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
• I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
• I verified that if a function's arguments changed that all usages have also been updated correctly
• If a new component is created I verified that:
  • A similar component doesn't exist in the codebase
  • All props are defined accurately and each prop has a /** comment above it */
  • The file is named correctly
  • The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
  • The only data being stored in the state is data necessary for rendering and nothing else
  • For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
  • Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
  • All JSX used for rendering exists in the render method
  • The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
• If any new file was added I verified that:
  • The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
• If a new CSS style is added I verified that:
  • A similar style doesn't already exist
  • The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG)
• If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
• If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
• If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
• If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
• I have checked off every checkbox in the PR author checklist, including those that don't apply to this PR.

Screenshots/Videos

Since we're only adding a translation function to the existing values and not any text visible directly on the app and the tests are working properly, I believe that videos for the same are not required. Let me know if you disagree.

[MelvinBot]

@dangrous @parasharrajat One of you needs to copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

[Prince-Mendiratta]

@pecanoro updated as per recommendations, thanks a lot for reviewing!

[dangrous]

This is looking great! All the existing code I think looks good, though I'll want to take a second look to double check stuff.

Two non-handled cases, not sure what we should do here:

• Icon component - here and here - I'm not really sure what we'd want to do with these ones. They end up in app with things like SvgPin Icon and SvgRoom Icon which aren't really helpful as accessibility hints. I'm tempted just to remove them entirely? They aren't used for testing AND they aren't good for accessibility... What do you all think?
• CalendarPicker - I think this is just a number, right? Still not ideal, but at least understandable. Just wanted to double check that this was the case.

[Prince-Mendiratta]

Icon Component

@dangrous This is a bit complicated, it renders the name by using the Icon name passed as the prop. This will require us to create an object with all icon names translated to spanish and then pass it as a different prop to the Icon component.

App/src/components/Icon/index.js

Line 55 in fa31301

accessibilityHint={`${this.props.src.name} Icon`}

I'd suggest to do nothing with this one since the major use case of pencil icon and pin icon in the LHN has a different accessibility label.

App/src/components/LHNOptionsList/OptionRowLHN.js

Line 223 in c3751b7

accessibilityLabel={props.translate('sidebarScreen.draftedMessage')}

App/src/components/LHNOptionsList/OptionRowLHN.js

Line 232 in c3751b7

accessibilityLabel={props.translate('sidebarScreen.chatPinned')}

CalendarPicker

Yup, the day is indeed just a number.

[dangrous]

Ah okay cool. I think we should go ahead and remove those accessibilityHints from the icons - since a hint is described as An accessibility hint helps users understand what will happen when they perform an action on the accessibility element when that result is not clear from the accessibility label. in the react native docs, it doesn't make sense to me to say the name of the icon, which doesn't add any information.

If that breaks any tests, let me know; we can probably figure out how to re-identify those elements...

[Prince-Mendiratta]

@dangrous There are a couple of tests that make use of icons as the anchor, listing them:

App/tests/unit/SidebarOrderTest.js

Line 153 in c3751b7

const pencilIcon = screen.getAllByAccessibilityHint('Pencil Icon');

App/tests/unit/SidebarOrderTest.js

Line 266 in c3751b7

expect(screen.getAllByAccessibilityHint('Pencil Icon')).toHaveLength(1);

App/tests/unit/SidebarOrderTest.js

Line 274 in c3751b7

expect(screen.queryAllByAccessibilityHint('Pencil Icon')).toHaveLength(0);

App/tests/unit/SidebarOrderTest.js

Line 365 in c3751b7

expect(screen.getAllByAccessibilityHint('Pencil Icon')).toHaveLength(1);

App/tests/unit/SidebarOrderTest.js

Line 299 in c3751b7

expect(screen.getAllByAccessibilityHint('Pin Icon')).toHaveLength(1);

App/tests/unit/SidebarOrderTest.js

Line 307 in c3751b7

expect(screen.queryAllByAccessibilityHint('Pin Icon')).toHaveLength(0);

App/tests/unit/SidebarOrderTest.js

Line 364 in c3751b7

expect(screen.getAllByAccessibilityHint('Pin Icon')).toHaveLength(1);

If you could please point out which direction I should proceed in to resolve this tests, I'll see what I can do!

[dangrous]

What do you think about using this? Is that easy? (I haven't done much with E2E tests before)

Though I'm wondering - if we use that here, should we use it for all of the other tests too?

[Prince-Mendiratta]

@parasharrajat @dangrous updated as per latest discussion in slack, please review!

[parasharrajat]

LGTM. No Screenshots are needed for this one.

1. All tests passed for me.
2. No Console errors.
3. Checked that every label and Hint is covered.
4. Run the app and changed the language on runtime to see the app works.

Reviewer Checklist

• I have verified the author checklist is complete (all boxes are checked off).
• I verified the correct issue is linked in the ### Fixed Issues section above
• I verified testing steps are clear and they cover the changes made in this PR
  • I verified the steps for local testing are in the Tests section
  • I verified the steps for Staging and/or Production testing are in the QA steps section
  • I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
  • I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
• I checked that screenshots or videos are included for tests on all platforms
• I included screenshots or videos for tests on all platforms
• I verified tests pass on all platforms & I tested again on:
  • Android / native
  • Android / Chrome
  • iOS / native
  • iOS / Safari
  • MacOS / Chrome / Safari
  • MacOS / Desktop
• If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
• I verified proper code patterns were followed (see Reviewing the code)
  • I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick).
  • I verified that comments were added to code that is not self explanatory
  • I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
  • I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
  • I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
  • I verified any copy / text that was added to the app is correct English and approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
  • I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
  • I verified the JSDocs style guidelines (in STYLE.md) were followed
• If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
• I verified that this PR follows the guidelines as stated in the Review Guidelines
• I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
• I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
• I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
• If a new component is created I verified that:
  • A similar component doesn't exist in the codebase
  • All props are defined accurately and each prop has a /** comment above it */
  • The file is named correctly
  • The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
  • The only data being stored in the state is data necessary for rendering and nothing else
  • For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
  • Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
  • All JSX used for rendering exists in the render method
  • The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
• If any new file was added I verified that:
  • The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
• If a new CSS style is added I verified that:
  • A similar style doesn't already exist
  • The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG)
• If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
• If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
• If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
• I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

cc: @pecanoro @dangrous

🎀 👀 🎀 C+ reviewed

[dangrous]

Love it!

Requested translation changes have been made

[OSBotify]

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

[OSBotify]

🚀 Deployed to staging by https://github.com/dangrous in version: 1.2.91-0 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅

[OSBotify]

🚀 Deployed to production by https://github.com/luacmartins in version: 1.2.91-1 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅