[Fix] Translated error messages #20093

fedirjh · 2023-06-02T20:16:13Z

Details

This PR builds upon the previous changes made in PR #19324 by refactoring the micro generated error and introducing key-based error storage. However, it has come to our attention that there are some components within the application that still handle errors using the old translation-based approach, resulting in inconsistencies. This follow-up PR aims to rectify this oversight by updating those components to utilize the new error handling mechanism.

Fixed Issues

$ #19324 (comment)
PROPOSAL: GH_LINK_ISSUE(COMMENT)

Tests

Test 1 : Bank Account

Prerequisite :

Update this line in /src/pages/ReimbursementAccount/BankAccountManualStep.js to

    submit(values) {
        Onyx.merge(ONYXKEYS.FORMS.REIMBURSEMENT_ACCOUNT_FORM, {
            errors: ErrorUtils.getMicroSecondOnyxError('paymentsPage.addBankAccountFailure')
        })
        return;
    }

Steps :

Open the app -> Workspaces -> Select workspace -> Bank Account -> Manual bank account
Add routing number 021000021
Add account number 231432
Click continue
Verify error message is displayed as An unexpected error occurred while trying to add your bank account. Please try again.

Test 2 : Account Details Login Page

Prerequisite :

Add the line below to /src/libs/actions/Session/index.js

errors: ErrorUtils.getMicroSecondOnyxError('loginForm.cannotGetAccountDetails'),

Update src/libs/API.js to include this line

    if (command === 'BeginSignIn'){
        return
    }

Steps :

Open App and logout if necessary
Enter Email and press Continue
Verify this message appears Couldn't retrieve account details, please try to sign in again.

Test 3 : Add Contact Method

Open App
Navigate to : Settings -> Profile -> Contact method
Add new contact method and verify that magic code is sent to new email
Select the newly added contact method
Verify that this message appears : Please enter the magic code sent to new add email

Verify that no errors appear in the JS console

Offline tests

QA Steps

Test 3 : Add Contact Method

Open App
Navigate to : Settings -> Profile -> Contact method
Add new contact method and verify that magic code is sent to new email
Select the newly added contact method
Verify that this message appears : Please enter the magic code sent to new add email

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

melvin-bot · 2023-06-02T20:16:17Z

Hey! I see that you made changes to our Form component. Make sure to update the docs in FORMS.md accordingly. Cheers!

melvin-bot · 2023-06-05T07:07:53Z

@arosiclair Please 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]

fedirjh · 2023-06-05T07:09:40Z

@luacmartins This is ready for review. I have added two tests. Please let me know if there are any other scenarios we should include in the tests.

arosiclair

LGTM. Lemme know if I should do the checklist

luacmartins

Looks good, but can we remove the translate call in other DotIndicatorMessage uses, e.g. here, here?

fedirjh · 2023-06-05T19:45:51Z

Good catch @luacmartins +1

fedirjh · 2023-06-05T20:40:44Z

Ready for another review , I have included an extra test for secondary contact method.

fedirjh · 2023-06-05T22:03:26Z

@luacmartins It looks that we should update all forms because we use translated errors in form validation as well. This will make the PR larger and have a broader scope, which may cause some delay . I suggest merging this PR for now, since the issue is already in production, and I will create another follow-up PR that covers all form validation methods.

@luacmartins what do you think about this plan ?

Here is an example

App/src/pages/settings/Profile/DisplayNamePage.js

Line 67 in 15dada7

    
           errors.lastName = this.props.translate('personalDetails.error.hasInvalidCharacter');

luacmartins · 2023-06-05T22:13:46Z

That plan seems fine to me.

luacmartins · 2023-06-05T22:22:55Z

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 the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- 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 grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is 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 code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
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 reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

web.mov

Mobile Web - Chrome

chrome.mov

Mobile Web - Safari

safari.mov

Desktop

desktop.mov

iOS

ios.mov

Android

android.mov

luacmartins · 2023-06-05T22:25:02Z

@fedirjh can you please create the follow up PR with the Form changes?

fedirjh · 2023-06-05T22:28:58Z

@luacmartins Sure, I will create a follow-up PR shortly.

OSBotify · 2023-06-05T22:31:38Z

✋ 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 · 2023-06-06T19:50:28Z

🚀 Cherry-picked to staging by https://github.com/luacmartins in version: 1.3.24-5 🚀

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

@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes.

OSBotify · 2023-06-07T03:27:43Z

🚀 Deployed to production by https://github.com/roryabraham in version: 1.3.24-5 🚀

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

OSBotify · 2023-06-07T13:19:22Z

🚀 Deployed to production by https://github.com/roryabraham in version: 1.3.24-5 🚀

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

fedirjh added 4 commits June 2, 2023 19:18

[Fix] Translate error keys

6b44bc2

Use FormHelpMessage

4dbb0da

Use key error, DotIndicatorMessage already translate keys if they exists

cb10ed9

run prettier

2ea8c12

fedirjh mentioned this pull request Jun 2, 2023

fix: show error message depend on the language preference #19324

Merged

56 tasks

luacmartins self-requested a review June 2, 2023 21:52

fedirjh marked this pull request as ready for review June 5, 2023 07:07

fedirjh requested a review from a team as a code owner June 5, 2023 07:07

melvin-bot bot requested review from arosiclair and removed request for a team June 5, 2023 07:07

arosiclair previously approved these changes Jun 5, 2023

View reviewed changes

luacmartins reviewed Jun 5, 2023

View reviewed changes

fedirjh added 3 commits June 5, 2023 21:19

Remove unecessary call

8f86f35

Update defaultProps to accept error with variables

b9fa9ae

run prettier

37a3705

fedirjh dismissed arosiclair’s stale review via 37a3705 June 5, 2023 20:24

fedirjh requested review from arosiclair and luacmartins June 5, 2023 20:40

Remove extra translate call

042f210

luacmartins approved these changes Jun 5, 2023

View reviewed changes

luacmartins merged commit 5a6d152 into Expensify:main Jun 5, 2023

fedirjh deleted the Fix-Translated-Errors branch June 6, 2023 19:58

fedirjh mentioned this pull request Jun 8, 2023

[Refactor] Form validation translated error #20228

Merged

57 tasks

stitesExpensify mentioned this pull request Jun 8, 2023

[HOLD for payment 2023-06-23] [$1000] Return the error key rather than the translated string in all forms #20472

Closed

6 tasks

[Fix] Translated error messages #20093

[Fix] Translated error messages #20093

Uh oh!

Conversation

fedirjh commented Jun 2, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

Test 1 : Bank Account

Test 2 : Account Details Login Page

Test 3 : Add Contact Method

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot bot commented Jun 2, 2023

Uh oh!

melvin-bot bot commented Jun 5, 2023

Uh oh!

fedirjh commented Jun 5, 2023

Uh oh!

arosiclair left a comment

Choose a reason for hiding this comment

Uh oh!

luacmartins left a comment

Choose a reason for hiding this comment

Uh oh!

fedirjh commented Jun 5, 2023

Uh oh!

fedirjh commented Jun 5, 2023

Uh oh!

fedirjh commented Jun 5, 2023

Uh oh!

luacmartins commented Jun 5, 2023

Uh oh!

luacmartins commented Jun 5, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

luacmartins commented Jun 5, 2023

Uh oh!

fedirjh commented Jun 5, 2023

Uh oh!

OSBotify commented Jun 5, 2023

Uh oh!

OSBotify commented Jun 6, 2023

Uh oh!

OSBotify commented Jun 7, 2023

Uh oh!

OSBotify commented Jun 7, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

fedirjh commented Jun 2, 2023 •

edited

Loading

luacmartins commented Jun 5, 2023 •

edited

Loading