Skip to content

Add timer to prevent over clicking of didn't receive a magic code button #20732

Merged
roryabraham merged 14 commits into
mainfrom
nikki-resend-validate-code-timer
Jun 22, 2023
Merged

Add timer to prevent over clicking of didn't receive a magic code button #20732
roryabraham merged 14 commits into
mainfrom
nikki-resend-validate-code-timer

Conversation

@NikkiWines

@NikkiWines NikkiWines commented Jun 14, 2023

Copy link
Copy Markdown
Contributor

Details

Users occasionally end up throttling themselves by over clicking the Didn't receive a magic code button. This is a quick UI update that should hopefully discourage that so that users are less likely to temporarily block themselves. '

Fixed Issues

$ https://github.com/Expensify/Expensify/issues/290805
PROPOSAL: N/A Internal

Tests

  1. Try to log into an Expensify account on new Expensify
  2. Confirm you get a notification with a magic code
  3. Confirm you see a countdown for requesting a new magic code
  4. Wait 30s until the countdown completes and request a new code when the view updates to the Didn't receive a magic code link
  5. Confirm you get a notification with another magic code
  6. Press the blue Go back link before the timer ends and re-enter your email
  7. Confirm the timer has restarted on the magic code view and that you receive another magic code notification
  8. Try to sign in without entering a code and confirm the timer has not restarted and that you see an appropriate error message
  9. Try to sign in with the incorrect code and confirm the timer has not restarted and confirm you see an appropriate error message
  10. Enter the correct code and confirm you can sign in successfully.
  • Verify that no errors appear in the JS console

Offline tests

  1. Try to log into an Expensify account on new Expensify
  2. Confirm you get a notification with a magic code
  3. Confirm you see a countdown for requesting a new magic code
  4. Go offline and confirm the UI updates to show the Didn't receive a magic code link and that it is disabled
image

QA Steps

  1. Try to log into an Expensify account on new Expensify
  2. Confirm you get a notification with a magic code
  3. Confirm you see a countdown for requesting a new magic code
  4. Wait 30s until the countdown completes and request a new code when the view updates to the Didn't receive a magic code link
  5. Confirm you get a notification with another magic code
  6. Press the blue Go back link before the timer ends and re-enter your email
  7. Confirm the timer has restarted on the magic code view and that you receive another magic code notification
  8. Try to sign in without entering a code and confirm the timer has not restarted and that you see an appropriate error message
  9. Try to sign in with the incorrect code and confirm the timer has not restarted and confirm you see an appropriate error message
  10. Enter the correct code and confirm you can sign in successfully.
  • 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 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
Screen.Recording.2023-06-13.at.20.38.52.mov
Mobile Web - Safari
mweb-safari.mp4
Desktop
desktop.mov
iOS
ios.mp4
Android
2023-06-14_14-54-47.mp4

@NikkiWines NikkiWines self-assigned this Jun 14, 2023
@NikkiWines NikkiWines marked this pull request as ready for review June 15, 2023 01:58
@NikkiWines NikkiWines requested a review from a team as a code owner June 15, 2023 01:58
@melvin-bot melvin-bot Bot requested review from roryabraham and s77rt and removed request for a team June 15, 2023 01:59
@melvin-bot

melvin-bot Bot commented Jun 15, 2023

Copy link
Copy Markdown

@s77rt @roryabraham 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]

Comment thread src/libs/actions/Session/index.js
Comment thread src/pages/signin/ValidateCodeForm/BaseValidateCodeForm.js Outdated
Comment thread src/pages/signin/ValidateCodeForm/BaseValidateCodeForm.js Outdated
Comment thread src/pages/signin/ValidateCodeForm/BaseValidateCodeForm.js Outdated
Comment thread src/pages/signin/ValidateCodeForm/BaseValidateCodeForm.js
Comment thread src/pages/signin/ValidateCodeForm/BaseValidateCodeForm.js
@NikkiWines

Copy link
Copy Markdown
Contributor Author

thanks for the review @s77rt 🙇 updated!

@s77rt

s77rt commented Jun 15, 2023

Copy link
Copy Markdown
Member

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.mp4
Mobile Web - Chrome
mweb-chrome.mp4
Mobile Web - Safari
mweb-safari.mp4
Desktop
desktop.mp4
iOS
ios.mp4
Android
android.mp4

@s77rt

s77rt commented Jun 15, 2023

Copy link
Copy Markdown
Member

Looks good but we have conflicts

@NikkiWines

Copy link
Copy Markdown
Contributor Author

updated once more to resolve conflicts

@s77rt

s77rt commented Jun 16, 2023

Copy link
Copy Markdown
Member

Retested. Working well 👍

@s77rt s77rt left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM! 🚀

cc @roryabraham

@melvin-bot

melvin-bot Bot commented Jun 16, 2023

Copy link
Copy Markdown

🎯 @s77rt, thanks for reviewing and testing this PR! 🎉

An E/App issue has been created to issue payment here: #20914.

Comment thread src/pages/signin/ValidateCodeForm/BaseValidateCodeForm.js

@roryabraham roryabraham left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Oh, nevermind I see you're actually displaying a timer. My bad, going too quick here...

Comment thread src/styles/styles.js Outdated
textAlign: 'center',
},

validateCodeTimer: {

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actually, this style is a duplicate of textBlue, so let's use that instead of introducing a new one. There is this checklist item:

If a new CSS style is added I verified that ... A similar style doesn't already exist

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Oops that's on me. Thanks @roryabraham

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Oops, I swear I looked for a matching style. Nice catch, @roryabraham!

@NikkiWines

Copy link
Copy Markdown
Contributor Author

@s77rt @roryabraham updated 🙇

@NikkiWines

Copy link
Copy Markdown
Contributor Author

Friendly bump on reviewing here @s77rt @roryabraham

@roryabraham roryabraham merged commit 692a1a3 into main Jun 22, 2023
@roryabraham roryabraham deleted the nikki-resend-validate-code-timer branch June 22, 2023 16:26
@OSBotify

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

🚀 Deployed to staging by https://github.com/roryabraham in version: 1.3.31-0 🚀

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

Comment on lines 27 to 28
import Terms from '../Terms';
import DotIndicatorMessage from '../../../components/DotIndicatorMessage';
import PressableWithFeedback from '../../../components/Pressable/PressableWithFeedback';
import usePrevious from '../../../hooks/usePrevious';

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Coming from this issue #21390 this implementation causes that if you go back and sign in again with the same email new magic code is sent as the timer got reset. I think its just a polish or maybe its something we are intentionally happy with but noting here #21390

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This is the expected behaviour

Press the blue Go back link before the timer ends and re-enter your email
Confirm the timer has restarted on the magic code view and that you receive another magic code notification

@OSBotify

Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/luacmartins in version: 1.3.31-3 🚀

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

@OSBotify

Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/luacmartins in version: 1.3.31-3 🚀

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

@Pujan92

Pujan92 commented Jun 26, 2023

Copy link
Copy Markdown
Contributor

@NikkiWines Seems a regression #21545 from this PR where an error display part has been moved.

@s77rt

s77rt commented Jun 26, 2023

Copy link
Copy Markdown
Member

Oh right, we missed that, the errors part was moved inside an if condition (covering only one case) where it used to cover two cases (outside the if condition).

@NikkiWines Can you draft a quick PR for this since I think this is within the regression period

@NikkiWines

Copy link
Copy Markdown
Contributor Author

Ah, yep - I can spin up a fix today

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.

6 participants