User facing errors and messages on success / failure of magic code sending

[Beamanator]

Details

A bit of #passwordless polish

Fixed Issues

$ #14687

Tests

1. Attempt to sign in using any email. (note - once you've hit a throttle you'll need to use another device, and possibly another IP address, so you'll need one for each device, or you'll need to run delete from nameValuePairs where name glob 'private_throttleAttempts_resendValidateCode*'; in your local db).
2. Re-request a magic code by tapping "Didn't receive a magic code?" and verify the message changes.
3. "Go back" and keep retrying login and code request until you hit the throttle (should be around three times of login + request code)
4. Verify that correct error message shows on the magic code page You've reached the maximum number of magic codes. Please wait a few minutes and try again.
5. Go back one more time and enter your email again. Verify that the correct error message shows on the email page - You need a magic code to sign in, but you've reached the maximum number of magic codes that can be sent. Please wait a few minutes and try again.

• Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

1. Attempt to sign in using any email on all devices (note - once you've hit a throttle you'll need to use another device, and possibly another IP address, so you'll need one for each device).
2. Re-request a magic code by tapping "Didn't receive a magic code?" and verify the message changes.
3. "Go back" and keep retrying login and code request until you hit the throttle (should be three times of login + request code)
4. Verify that correct error message shows: You've reached the maximum number of magic codes. Please wait a few minutes and try again.
5. Go back one more time and enter your email again. Verify that the correct error message shows on the email page - You need a magic code to sign in, but you've reached the maximum number of magic codes that can be sent. Please wait a few minutes and try again.

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

Screenshots/Videos

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

[MelvinBot]

@dangrous @Santhosh-Sellavel 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]

[MelvinBot]

@dangrous @eVoloshchak 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]

[dangrous]

@NikkiWines this is ready for your review - comment is updated!

As for the test/QA steps, it's tricky. I've updated them to be clearer, but we're looking for one error message that will show if you hit the throttle when clicking "Didn't receive a magic code?" - which is You've reached the maximum number of magic codes. Please wait a few minutes and try again. and then ANOTHER error message that will show if you've hit the throttle when on the email entry page - You need a magic code to sign in, but you've reached the maximum number of magic codes that can be sent. Please wait a few minutes and try again.

The steps I put above hit these in the right order pretty regularly, but it looks like that wasn't the case for you - were you maybe using an Expensify email with a different limit? I want to make sure this will be easily grabbable by QA...

[NikkiWines]

Hmm, yeah tbh I'm not sure why we have such a minor difference in copy for effectively the same error message (with the same outcome - wait for a bit and try again)

I'll try again - I was just using a random dev email, not an expensify/expensifail domain one

[dangrous]

Hmm, yeah tbh I'm not sure why we have such a minor difference in copy for effectively the same error message (with the same outcome - wait for a bit and try again)

We can keep it the same I guess? We need a specific message there otherwise it uses the generic "contact concierge" and it's set in a different place. But we could use the same one. In this case I felt it might be confusing to talk about magic codes where there is no reference on the page to magic codes... so tried to give it a bit more context here, but definitely open for discussion

[NikkiWines]

In this case I felt it might be confusing to talk about magic codes where there is no reference on the page to magic codes... so tried to give it a bit more context here, but definitely open for discussion

Ah, I see. No, I think its fine. Tried once more and it's working as expected and I think the steps are sufficiently clear 👍

[dangrous]

Okay conflicts resolved, @Santhosh-Sellavel we should be ready for your review now! (the backend change is on prod)

[Santhosh-Sellavel]

@dangrous Cool @dangrous, Can you re-request review, so I don't miss this one, thanks!

[Santhosh-Sellavel]

@Beamanator @dangrous Can anyone add my account passwordless beta

Santhoshsellavel+betas@gmail.com

[NikkiWines]

@Santhosh-Sellavel I've added that email to the beta, it make take a little while for it to apply to your account

[NikkiWines]

👍

[Santhosh-Sellavel]

How long is the wait time here to try again after the error? @Beamanator @dangrous

@NikkiWines
Can you add these accounts also to passwordless beta, I'm unable to test success case now as I am stuck with error

santhoshsellavel+beta1@gmail.com
santhoshsellavel+beta2@gmail.com

[NikkiWines]

How long is the wait time here to try again after the error?

2 hours assuming you don't hit the IP throttling. I am able to remove the throttling for your account if necessary @Santhosh-Sellavel

Can you add these accounts also to passwordless beta, I'm unable to test success case now as I am stuck with error

done

[Santhosh-Sellavel]

Cool, I saw both error messages, I'll quickly test success cases and capture possible error scenarios. Thanks!

[Santhosh-Sellavel]

I'll test this tomorrow!

[Santhosh-Sellavel]

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.
• 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 & Desktop

Screen.Recording.2023-02-23.at.10.19.39.PM.mov

Mobile Web - Chrome & Mobile Web - Safari

Screen.Recording.2023-02-23.at.10.38.39.PM.mov

iOS & Android

Screen.Recording.2023-02-23.at.10.42.22.PM.mov

[Santhosh-Sellavel]

LGTM, tests well!

[github-actions]

Performance Comparison Report 📊

Significant Changes To Duration

There are no entries

Meaningless Changes To Duration

Show entries

Name	Duration
App start TTI	713.397 ms → 732.560 ms (+19.163 ms, +2.7%)
Open Search Page TTI	603.592 ms → 606.227 ms (+2.634 ms, ±0.0%)
App start nativeLaunch	19.143 ms → 19.742 ms (+0.599 ms, +3.1%)
App start regularAppStart	0.014 ms → 0.015 ms (+0.002 ms, +11.6%)
App start runJsBundle	202.406 ms → 198.906 ms (-3.500 ms, -1.7%)

Show details

Name	Duration
App start TTI	Baseline Mean: 713.397 ms Stdev: 31.523 ms (4.4%) Runs: 656.8626600001007 657.4043649993837 658.3516680002213 679.147539999336 681.783438000828 682.8162660002708 687.1624490004033 691.8729279991239 694.0792590007186 694.8134139999747 695.2950780000538 696.4564989991486 700.6827450003475 706.6941250003874 708.8572199996561 713.196072999388 714.2549120001495 716.1899950001389 717.0070650000125 720.4261930007488 726.2183180004358 726.6616910006851 727.9201459996402 730.6496130004525 739.4835170004517 739.7531429994851 745.242886999622 751.7581699993461 754.0475440006703 762.1932369992137 771.2783720009029 780.1340660005808 Current Mean: 732.560 ms Stdev: 24.330 ms (3.3%) Runs: 680.2484460007399 696.5842160005122 697.7220419999212 704.8046310003847 707.6114920005202 710.1175769995898 715.2374329995364 716.2168829999864 716.5033369995654 718.1339430008084 720.8447430003434 721.1868670005351 723.4387589991093 725.9787269998342 726.6798390001059 729.5690710004419 732.2508889995515 735.206880999729 736.131115000695 737.2624420002103 742.0400830004364 743.6390480007976 750.8890370000154 751.5213970001787 757.9480409994721 758.9785370007157 764.9391660001129 765.9905970003456 767.7685540001839 769.9449320007116 783.9767400007695
Open Search Page TTI	Baseline Mean: 603.592 ms Stdev: 17.274 ms (2.9%) Runs: 568.4582519996911 572.4465330000967 586.7772220000625 587.7992360014468 588.1228840015829 588.2092690002173 589.6276450008154 589.6977539993823 593.2628169991076 594.7795000001788 594.8490800000727 595.5938730016351 595.6487630009651 595.7438559997827 603.2104090005159 604.4919029995799 604.7424720004201 604.9237469993532 606.0550939999521 607.0210369993001 609.1217849999666 609.2624109983444 610.6000159997493 611.6005049999803 612.7433280013502 622.7154140006751 625.156006000936 625.7306319996715 629.4993500001729 638.834391001612 644.6315519995987 Current Mean: 606.227 ms Stdev: 17.067 ms (2.8%) Runs: 574.3484299983829 579.95727599971 582.7452399991453 586.3518070001155 587.3984790015966 588.0820720009506 588.3168949987739 590.2210699990392 591.3301189988852 597.4428710006177 598.0026860013604 599.265829000622 599.7605389989913 601.6628830004483 601.7134610004723 603.0845139995217 605.5635170005262 606.4389239996672 606.4853520002216 610.0256350003183 611.6863610018045 613.9038089998066 620.2775070015341 623.0881350003183 623.6776940003037 624.8656419999897 625.7808440010995 626.6022539995611 627.8180350009352 632.0375169999897 635.0921630002558 636.2207440007478
App start nativeLaunch	Baseline Mean: 19.143 ms Stdev: 1.301 ms (6.8%) Runs: 17 18 18 18 18 18 18 18 18 18 19 19 19 19 19 19 19 19 19 20 20 20 20 20 20 21 22 23 Current Mean: 19.742 ms Stdev: 1.544 ms (7.8%) Runs: 18 18 18 18 18 18 18 18 19 19 19 19 19 19 19 20 20 20 20 20 20 20 20 20 21 21 22 22 23 23 23
App start regularAppStart	Baseline Mean: 0.014 ms Stdev: 0.001 ms (4.5%) Runs: 0.0125730000436306 0.012653999030590057 0.012816999107599258 0.012817999348044395 0.012817999348044395 0.01285799965262413 0.013020999729633331 0.01302100159227848 0.01314300112426281 0.013224000111222267 0.013224000111222267 0.013387000188231468 0.013468001037836075 0.013589998707175255 0.013590998947620392 0.013590998947620392 0.013591000810265541 0.013591000810265541 0.01371300034224987 0.013752998784184456 0.013834001496434212 0.013956999406218529 0.013957001268863678 0.013996999710798264 0.014038000255823135 0.01407800056040287 0.014322999864816666 0.014364000409841537 0.01452699862420559 0.014730000868439674 0.014973999932408333 Current Mean: 0.015 ms Stdev: 0.001 ms (5.4%) Runs: 0.013753999024629593 0.014079000800848007 0.01411999948322773 0.014281999319791794 0.01428299956023693 0.01428299956023693 0.014444999396800995 0.014445001259446144 0.014607999473810196 0.01464799977838993 0.014729999005794525 0.014770999550819397 0.014892999082803726 0.014973999932408333 0.015096001327037811 0.015135999768972397 0.015258999541401863 0.015300000086426735 0.015542998909950256 0.015583999454975128 0.015666000545024872 0.015666000545024872 0.015706999227404594 0.01574699953198433 0.01574699953198433 0.015949999913573265 0.015991000458598137 0.015991000458598137 0.016520000994205475 0.01757900044322014
App start runJsBundle	Baseline Mean: 202.406 ms Stdev: 23.985 ms (11.9%) Runs: 168 174 175 176 180 180 181 182 182 185 186 186 190 191 192 198 200 203 206 207 208 208 208 208 215 231 235 238 239 240 243 262 Current Mean: 198.906 ms Stdev: 15.140 ms (7.6%) Runs: 174 176 180 181 181 184 187 188 188 189 189 190 190 193 196 199 199 200 201 201 203 203 205 208 209 213 216 216 220 224 229 233

[OSBotify]

🚀 Deployed to staging by https://github.com/NikkiWines in version: 1.2.76-5 🚀

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

[OSBotify]

🚀 Deployed to production by https://github.com/yuwenmemon in version: 1.2.76-7 🚀

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

[OSBotify]

🚀 Deployed to production by https://github.com/yuwenmemon in version: 1.2.76-7 🚀

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

[OSBotify]

🚀 Deployed to production by https://github.com/yuwenmemon in version: 1.2.76-7 🚀

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

[s77rt]

Changing the loading state to true caused a "regression". This made the sign in button show a loader which is kinda odd because the user didn't click on that button. (Coming from #22083)

[dangrous]

makes sense, thank you!