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.

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: show error message depend on the language preference #19324

Merged
merged 10 commits into from
May 23, 2023

Conversation

StevenKKC
Copy link
Contributor

@StevenKKC StevenKKC commented May 19, 2023

Details

Fixed Issues

$ #18203
PROPOSAL: #18203(COMMENT)

Tests

  1. Go Preference
  2. Set offline
  3. Change the language to Spanish
  4. Click on new chat with invalid number, example +15005550111
  5. Send messages
  6. Go back to Preference, change the language to English
  7. Go to the same chat again and set online
  8. Verify that the error messages is shown in English when the language was already changed to English.
  • The error message should be shown in English

Offline tests

QA Steps

Same as Tests step.

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)
    In web and desktop version, there's a console error that is not related to this PR. A console error is generated in src/styles/getTooltipStyles.js and src/libs/BootSplash/index.js, and display error screen.
    I think should open an issue for it.

  • 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 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
      • 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:
    • 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 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 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web
web.mov
Mobile Web - Chrome
mobile.web.chrome.mp4
Mobile Web - Safari
mobile.web.safari.mov
Desktop
desktop.mov
iOS
iOS.mov
Android
Android.mp4

@StevenKKC StevenKKC requested a review from a team as a code owner May 19, 2023 22:23
@github-actions
Copy link
Contributor

github-actions bot commented May 19, 2023

CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅

@melvin-bot melvin-bot bot removed the request for review from a team May 19, 2023 22:24
@melvin-bot
Copy link

melvin-bot bot commented May 19, 2023

@amyevans 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]

Copy link
Contributor

@fedirjh fedirjh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@StevenKKC As this is your first time contribution , you need to sign the CLA , check this #19324 (comment) . Also please update the checklist , the template should’ve been maintained . There are some lint error that you should fix as well.

Please include all screenshots for all platforms.

@@ -64,7 +65,7 @@ const DotIndicatorMessage = (props) => {
key={i}
style={styles.offlineFeedback.text}
>
{message}
{Localize.translateError(message)}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
{Localize.translateError(message)}
{message}

Let's move this to line 51 as bellow :

const sortedMessages = _.chain(props.messages)
        .keys()
        .sortBy()
        .map((key) => props.messages[key])
        // Using uniq here since some fields are wrapped by the same OfflineWithFeedback component (e.g. WorkspaceReimburseView)
        // and can potentially pass the same error.
        .uniq()
        .map((message) => Localize.translateError(message))
        .value();

@@ -91,6 +91,24 @@ function translateLocal(phrase, variables) {
return translate(BaseLocaleListener.getPreferredLocale(), phrase, variables);
}

/**
* Return translated message for phrase.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Return translated message for phrase.
* Return translated string for given error

@@ -81,7 +81,7 @@ function getVBBADataForOnyx() {
value: {
isLoading: false,
errors: {
[DateUtils.getMicroseconds()]: Localize.translateLocal('paymentsPage.addBankAccountFailure'),
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we can extract this part to ErrorUtils.js as below :

/**
 * Method used to generate errors object for optimistic 
 * @param {String} error - error key or message to be saved 
 * @return {Object} - Object to be optimistically saved to Onyx
 *
 */
function getOptimisticErrors(error){
    return ({[DateUtils.getMicroseconds()]: error});
}

// Use It as

errors: ErrorUtils.getOptimisticErrors('paymentsPage.addBankAccountFailure'),

Copy link
Contributor

@luacmartins luacmartins Jun 2, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@fedirjh @chiragsalian @StevenKKC We're passing 'paymentsPage.addBankAccountFailure' to the utility method, but all it's doing is storing that key as the error instead of translating it. So this is what the error looks like:

Screenshot 2023-06-02 at 10 04 35 AM

but it should be:

1685721717986000: "An unexpected error occurred while trying to add your bank account. Please try again."

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@luacmartins Yes , We save the key then we translate it inside DotIndicatorMessage.js

.map((message) => Localize.translateIfPhraseKey(message))

We check if the key exists in the translation directory , then we translate it , If it's from backend then it will be displayed as it it's

function translateIfPhraseKey(phrase) {
try {
return translateLocal(phrase);
} catch (error) {
return phrase;
}
}

Is there any issue with that ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@luacmartins Storing the key is correct, and when display that error message, the key will be translated to the message.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We're only calling translateIfPhraseKey in DotIndicator, but there are other places displaying the error text, e.g. Forms, that don't use DotIndicator.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh! We missed that case.

@luacmartins should we raise a new PR to address that or should we revert ?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is in prod already, so it's a regression and we should raise a PR to fix it.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

cc @luacmartins I have raised a draft PR #20093 , can you please check it

@StevenKKC
Copy link
Contributor Author

I have read the CLA Document and I hereby sign the CLA

@fedirjh
Copy link
Contributor

fedirjh commented May 20, 2023

@StevenKKC Please fix the failing tests as well , you need to update them with the new approach.

@StevenKKC
Copy link
Contributor Author

@fedirjh Updated.
Sorry, I'm not pay attention to many things.
I have fixed lint errors, and according to your suggestion, added a utility function. Please review again.
Android screenshot and mobile chrome screenshot, I'll upload a little later.

@StevenKKC StevenKKC requested a review from fedirjh May 20, 2023 13:12
@fedirjh
Copy link
Contributor

fedirjh commented May 21, 2023

@StevenKKC Can you please merge main. Please update tests step as well

Notice that the error messages is shown in Spanish even when the language was already changed to English in offline mode.

Verify that the error messages is shown in English when the language was already changed to English.

@fedirjh
Copy link
Contributor

fedirjh commented May 21, 2023

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

@fedirjh
Copy link
Contributor

fedirjh commented May 21, 2023

Android screenshot and mobile chrome screenshot, I'll upload a little later.

@StevenKKC The changes look good. Please include the missing screenshots and address my comment #19324 (comment)

@StevenKKC
Copy link
Contributor Author

@fedirjh Uploaded the missing screenshots and tests step.

fedirjh
fedirjh previously approved these changes May 22, 2023
Copy link
Contributor

@fedirjh fedirjh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me.

cc @chiragsalian

🎀👀🎀 C+ reviewed

@StevenKKC
Copy link
Contributor Author

@fedirjh Thanks for your review.

@chiragsalian Could you please review my PR?

@StevenKKC
Copy link
Contributor Author

@fedirjh @chiragsalian Because of conflict, I have merged main branch into my branch.

@StevenKKC StevenKKC requested a review from fedirjh May 22, 2023 20:09
@StevenKKC
Copy link
Contributor Author

@chiragsalian Updated files according to your suggestion.

@StevenKKC StevenKKC requested a review from chiragsalian May 22, 2023 23:34
@StevenKKC
Copy link
Contributor Author

@chiragsalian @fedirjh All checks have passed. What can I do for this now?

@StevenKKC
Copy link
Contributor Author

@chiragsalian Could you please review the changes that you requested? I hope to merge this PR as soon as possible.

Copy link
Contributor

@chiragsalian chiragsalian left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yup i wanted to discuss this solution with my team so it took me a bit.

Looks like you missed a spot here and here.

Other than that code LGTM. i left some minor suggestion just to improve readability.

chiragsalian

This comment was marked as duplicate.

@StevenKKC
Copy link
Contributor Author

@chiragsalian I have updated files according to your request. Could you please review again?

@StevenKKC StevenKKC requested a review from chiragsalian May 23, 2023 18:51
Copy link
Contributor

@chiragsalian chiragsalian left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you missed addressing this comment of mine.
Specifically this one,

Looks like you missed a spot here and here.

@fedirjh
Copy link
Contributor

fedirjh commented May 23, 2023

There is an extra eslint comment here on line 43 that should be removed as well

@StevenKKC
Copy link
Contributor Author

@chiragsalian @fedirjh Updated.

@StevenKKC StevenKKC requested a review from chiragsalian May 23, 2023 19:34
@StevenKKC
Copy link
Contributor Author

@chiragsalian All checks have passed. Please let me know what I should do.

Copy link
Contributor

@chiragsalian chiragsalian left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@chiragsalian
Copy link
Contributor

chiragsalian commented May 23, 2023

I'm going ahead and merging since fedi already approved it earlier and his most recent review comment was minor.

@chiragsalian chiragsalian merged commit 8da2827 into Expensify:main May 23, 2023
@OSBotify
Copy link
Contributor

✋ 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
Copy link
Contributor

🚀 Deployed to staging by https://github.com/chiragsalian in version: 1.3.18-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/chiragsalian in version: 1.3.18-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/chiragsalian in version: 1.3.18-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/yuwenmemon in version: 1.3.18-2 🚀

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

@StevenKKC
Copy link
Contributor Author

StevenKKC commented May 26, 2023

I have checked the Deploy checklist (#19565) and the issue #19651 (#19651).

But I think it's not related to this PR at all.

When user change the language preference, the following code will be executed.

function setLocale(locale) {
if (locale === preferredLocale) {
return;
}
// If user is not signed in, change just locally.
if (!currentUserAccountID) {
Onyx.merge(ONYXKEYS.NVP_PREFERRED_LOCALE, locale);
return;
}
// Optimistically change preferred locale
const optimisticData = [
{
onyxMethod: Onyx.METHOD.MERGE,
key: ONYXKEYS.NVP_PREFERRED_LOCALE,
value: locale,
},
];
API.write(
'UpdatePreferredLocale',
{
value: locale,
},
{optimisticData},
);
}

In the offline mode (or the user have already changed the force offline mode to online, but the app is still in the offline status, as you can see in your video), API.write only change the local Onyx data, and the request API that update the language preference does not send to the server.

screenshot

After send the comment, the server will send the response error message and the Onyx data that is stored in the server to the app, and these data will contain the original language preference, as you can see in the below screenshot.

screenshot1

So, after app receive the server response and merge the server's Onyx data, the language preference will be changed to the previous state, that is Spanish, and the error message is shown in Spanish.

That is, this PR is working as expected.

And now, there is a new issue opened.

@fedirjh
Copy link
Contributor

fedirjh commented May 26, 2023

@StevenKKC you should post that in the the other issue. That would be helpful to identify the root cause of the other issue, And if we find that the root cause is related to this PR , then we can flag it as regression and proceed with a fix.

Edit : I agree with your analysis , this issue is not related to the changes with this PR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants