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: Link has been sent text dynamic translation on login screens #17351

Merged
merged 3 commits into from
Apr 14, 2023

Conversation

Pujan92
Copy link
Contributor

@Pujan92 Pujan92 commented Apr 12, 2023

Details

Moved translations logic for the resendValidationForm.linkHasBeenResent from onyx success object to respective components which assures those texts are dynamic.

Fixed Issues

$ #17216
PROPOSAL: #17216 (comment)

Tests

  1. In magic link/forgot password screen click on the Resend button
  2. It shows the success text Link has been re-sent if the current language in english
  3. Switch language to spanish
  4. Verify the success text translated to spanish
  • Verify that no errors appear in the JS console

Offline tests

  1. In magic link/forgot password screen click on the Resend button
  2. It shows the success text Link has been re-sent if the current language in english
  3. Switch language to spanish
  4. Verify the success text translated to spanish

QA Steps

  1. In magic link/forgot password screen click on the Resend button
  2. It shows the success text Link has been re-sent if the current language in english
  3. Switch language to spanish
  4. Verify the success text translated to spanish
  • 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:
    • 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 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
Screen.Recording.2023-04-12.at.8.53.56.PM.mov
Screen.Recording.2023-04-13.at.8.08.20.PM.mov
Mobile Web - Chrome

mobile (22)
mobile (23)
mobile (25)
mobile (26)

Mobile Web - Safari

mobile (18)
mobile (19)
mobile (20)
mobile (21)

Desktop
Screen.Recording.2023-04-12.at.10.57.07.PM.mov
iOS
Simulator.Screen.Recording.-.iPhone.14.-.2023-04-12.at.22.53.51.mp4
Android
anaa.mp4

@Pujan92 Pujan92 requested a review from a team as a code owner April 12, 2023 17:33
@melvin-bot melvin-bot bot requested review from mollfpr and tgolen and removed request for a team April 12, 2023 17:33
@MelvinBot
Copy link

@tgolen @mollfpr 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]

tgolen
tgolen previously approved these changes Apr 13, 2023
Copy link
Contributor

@tgolen tgolen left a comment

Choose a reason for hiding this comment

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

Code change looks good to me. I will let @mollfpr test it and go through the checklist.

@mollfpr
Copy link
Contributor

mollfpr commented Apr 13, 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 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 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
17351.Web.-.resend.validation.link.mov
17351.Web.-.resend.magic.code.mov
17351.Web.-.resend.reset.password.mov
Mobile Web - Chrome
17351.mWeb.Chrome.-.resend.validation.link.mov
17351.mWeb.Chrome.-.resend.reset.password.mov
Mobile Web - Safari
17351.mWeb.Safari.-.resend.validation.link.mp4
17351.mWeb.Safari.-.resend.reset.password.mp4
Desktop
17351.Desktop.-.resend.validation.link.mov
17351.Desktop.-.resend.magic.code.mov
17351.Desktop.-.resend.reset.password.mov
iOS
17351.iOS.-.resend.validation.link.mp4
17351.iOS.-.resend.reset.password.mp4
17351.iOS.-.resend.magic.code.mp4
Android
17351.Android.-.resend.validation.link.mov
17351.Android.-.resend.reset.password.mov

@mollfpr
Copy link
Contributor

mollfpr commented Apr 13, 2023

@Pujan92 Could you check with the resend code use case? I got an error with the page after click on Didn't receive a magic code?

Screen.Recording.2023-04-13.at.21.08.03.mov

@Pujan92
Copy link
Contributor Author

Pujan92 commented Apr 13, 2023

@Pujan92 Could you check with the resend code use case? I got an error with the page after click on Didn't receive a magic code?

Thanks @mollfpr , I am seeing that we are trying to show the message with only linkSent state variable before the magic code api gets completed. So needed to consider account.message also which I just committed.

@mollfpr
Copy link
Contributor

mollfpr commented Apr 13, 2023

@Pujan92 Yeah, I see that too. How about returning an empty string when there's no this.props.account.message?

{this.props.account.message ? this.props.translate(this.props.account.message) : ''}

@Pujan92
Copy link
Contributor Author

Pujan92 commented Apr 13, 2023

@Pujan92 Yeah, I see that too. How about returning an empty string when there's no this.props.account.message?

Yes @mollfpr , this makes more sense as the link gets hidden on the click.

Copy link
Contributor

@mollfpr mollfpr left a comment

Choose a reason for hiding this comment

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

LGTM and test well 👍

@tgolen tgolen merged commit ea3d656 into Expensify:main Apr 14, 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/tgolen in version: 1.3.1-0 🚀

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

1 similar comment
@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/tgolen in version: 1.3.1-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/mountiny in version: 1.3.1-3 🚀

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

@Pujan92
Copy link
Contributor Author

Pujan92 commented Apr 22, 2023

@mollfpr we have missed one case where we are not applying translate due to which it shows the key for the message in ExpiredValidateCodeModal.js. Ref - https://expensify.slack.com/archives/C049HHMV9SM/p1682137890899889

const codeRequestedMessage = lodashGet(this.props, 'account.message', null);

@mollfpr
Copy link
Contributor

mollfpr commented Apr 22, 2023

@Pujan92 Yeah, definitely we missed that. I was sure to mention where account.message is used 😕

@tgolen Any suggestion on how we proceed with the regression fix? I think we can log that report and create the issue that creates a PR fix based on that, so we can pay the reporter and log the regression for the first issue.

@Pujan92
Copy link
Contributor Author

Pujan92 commented Apr 22, 2023

I might have seen it but somehow I missed that, sorry for it.

@mollfpr
Copy link
Contributor

mollfpr commented Apr 22, 2023

No worries, it's also my responsibility. Let's take this as a lesson to the future 👍

@tgolen
Copy link
Contributor

tgolen commented Apr 24, 2023

I believe this is still in the 7 day regression period, so I think we should just do a new PR with this issue here to get it fixed.

@mollfpr
Copy link
Contributor

mollfpr commented Apr 24, 2023

Thanks @tgolen!

@Pujan92 Please proceed with the PR fix. Thank you!

@Pujan92
Copy link
Contributor Author

Pujan92 commented Apr 24, 2023

Thanks! PR is here.

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