Fix: 18183 spinner persists to magic code section #19393

tienifr · 2023-05-22T16:42:08Z

Details

Fixed Issues

$ #18183
PROPOSAL: #18183 (comment)

Tests

Navigate to sing in page
Enter email and click on continue
Verify the spinner shouldn't persist to magic code section for the action taken on email section
Enter magic code
If 2FA is enable, verify the spinner shouldn't persist to 2fa section

Verify that no errors appear in the JS console

Offline tests

Same as above

QA Steps

Navigate to sing in page
Enter email and click on continue
Verify the spinner shouldn't persist to magic code section for the action taken on email section
Enter magic code
If 2FA is enable, verify the spinner shouldn't persist to 2fa section

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

Screen.Recording.2023-05-22.at.22.49.19.mp4

Mobile Web - Chrome

RPReplay_Final1684770967.mp4

Mobile Web - Safari

RPReplay_Final1684770823.mp4

Desktop

Screen.Recording.2023-05-22.at.23.38.46.mp4

iOS

Screen.Recording.2023-05-22.at.23.35.30.mp4

Android

Screen.Recording.2023-05-22.at.23.20.22.mp4

melvin-bot · 2023-05-22T16:50:57Z

@Julesssss @aimane-chnaif 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]

src/libs/SessionUtils.js

aimane-chnaif · 2023-05-23T12:38:59Z

@tienifr let me know if it makes sense
main...aimane-chnaif:Expensify:fix/19393-spinner

cc: @Julesssss

tienifr · 2023-05-23T15:07:50Z

isLoading={this.props.account.isLoading && this.props.account.loadingForm === CONST.FORMS.VALIDATE_CODE_FORM}

@aimane-chnaif Thanks for your suggestion, but I wonder why the spinner doesn't persist to 2fa section once user enters magic code. isLoading and loadingForm will reset to null in successData/failureData at the same time

tienifr · 2023-05-23T15:11:33Z

When we click Didn't receive a magic code? isLoading in BaseValidateCodeForm or PasswordForm should be true right?

aimane-chnaif · 2023-05-23T15:12:46Z

@aimane-chnaif Thanks for your suggestion, but I wonder why the spinner doesn't persist to 2fa section once user enters magic code. isLoading and loadingForm will reset to null in successData/failureData at the same time

You mean my branch is currently wrong but magically works or not working as expected?

aimane-chnaif · 2023-05-23T15:14:19Z

When we click Didn't receive a magic code? isLoading in BaseValidateCodeForm or PasswordForm should be true right?

No, I didn't put loading in resendValidateCode so should be fine.

aimane-chnaif · 2023-05-23T15:16:53Z

@tienifr btw, you can adjust and fix while testing based on my branch. It may not be perfect but just gave idea.

…tion

tienifr · 2023-05-23T16:17:15Z

changing loadingScreen to loadingForm is good
I also want to update the CONST like your suggestion

FORMS: {
        LOGIN_FORM: 'LoginForm',
        VALIDATE_CODE_FORM: 'ValidateCodeForm',
        RESEND_VALIDATION_FORM: 'ResendValidationForm',
        UNLINK_LOGIN_FORM: 'UnlinkLoginForm',
    },

But if we do:

isLoading = {this.props.account.isLoading && this.props.account.loadingForm === CONST.FORMS.VALIDATE_CODE_FORM}

When resend validation code, the loading indicator isn't shown. Is it OK?

Screen.Recording.2023-05-23.at.22.49.02.mov

Another problem:

Users enter validate code => isLoading = true, loadingForm = ValidateCodeForm
the loading indicator is shown
BE's results update requiresTwoFactorAuth = true
2FA input is displayed while loading indicator persists // This is the problem
Reset isLoading = false and loadingForm = null in successData

That why I want to create a new function shouldShowLoadingIndicatorForScreen in my PR.

I want to know your thought @aimane-chnaif. Thanks

aimane-chnaif · 2023-05-23T16:30:24Z

When resend validation code, the loading indicator isn't shown. Is it OK?

~~This is happening on main, right?~~ b3d928e

2FA input is displayed while loading indicator persists // This is the problem

d44a94c
will this work?

tienifr · 2023-05-23T16:36:35Z

This is happening on main, right?

@aimane-chnaif No, here's what happens on main

Screen.Recording.2023-05-23.at.23.35.53.mov

aimane-chnaif · 2023-05-23T16:41:50Z

@tienifr I see. updated comment.
Let me know if it works

tienifr · 2023-05-23T17:13:43Z

@aimane-chnaif Thanks for your suggestion. I've updated my PR. I know the reason why you want to preserve isLoading in optimisticData, because it can be used in other places. I also tested all cases and there's no regressions came from my PR, but please help check and re-test.

aimane-chnaif · 2023-05-24T12:50:08Z

@tienifr please fix conflict

aimane-chnaif · 2023-05-24T16:04:37Z

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

mchrome.mov

Mobile Web - Safari

msafari.mov

Desktop

desktop.mov

iOS

ios.mov

Android

android.mov

aimane-chnaif

@Julesssss LGTM!

Julesssss

Nice work!

OSBotify · 2023-05-24T16:20:26Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

OSBotify · 2023-05-25T00:33:57Z

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

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

OSBotify · 2023-05-25T01:07:28Z

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

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

OSBotify · 2023-05-25T01:29:25Z

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

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

OSBotify · 2023-05-26T07:06:37Z

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

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

Fix: 18183 spinner persists to magic code section

b28e8e1

tienifr marked this pull request as ready for review May 22, 2023 16:50

tienifr requested a review from a team as a code owner May 22, 2023 16:50

melvin-bot bot requested review from aimane-chnaif and Julesssss and removed request for a team May 22, 2023 16:50

tienifr mentioned this pull request May 22, 2023

[HOLD for payment 2023-06-02] [$1000] Spinner persists to magic code section once user enters email and clicks on continue #18183

Closed

6 tasks

Julesssss assigned tienifr May 23, 2023

Julesssss reviewed May 23, 2023

View reviewed changes

src/libs/SessionUtils.js Outdated Show resolved Hide resolved

fix: change func name

373f9e0

Merge branch 'main' into fix/18183-spinner-persists-to-magic-code-sec…

c816536

…tion

fix: update logic show spinner

11bf9fe

fix conflict

ae75177

aimane-chnaif approved these changes May 24, 2023

View reviewed changes

Julesssss approved these changes May 24, 2023

View reviewed changes

Julesssss merged commit 971bf7f into Expensify:main May 24, 2023

OSBotify mentioned this pull request May 25, 2023

Deploy Checklist: New Expensify 2023-05-25 #19565

Closed

53 tasks

Ollyws mentioned this pull request Sep 1, 2023

[HOLD for payment 2023-09-21] [$1000] Log in -Didn't receive magic code button is clickable while loading #25932

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix: 18183 spinner persists to magic code section #19393

Fix: 18183 spinner persists to magic code section #19393

tienifr commented May 22, 2023

melvin-bot bot commented May 22, 2023

aimane-chnaif commented May 23, 2023

tienifr commented May 23, 2023

tienifr commented May 23, 2023

aimane-chnaif commented May 23, 2023

aimane-chnaif commented May 23, 2023

aimane-chnaif commented May 23, 2023

tienifr commented May 23, 2023 •

edited

Loading

aimane-chnaif commented May 23, 2023 •

edited

Loading

tienifr commented May 23, 2023

aimane-chnaif commented May 23, 2023

tienifr commented May 23, 2023

aimane-chnaif commented May 24, 2023

aimane-chnaif commented May 24, 2023

aimane-chnaif left a comment

Julesssss left a comment

OSBotify commented May 24, 2023

OSBotify commented May 25, 2023

OSBotify commented May 25, 2023

OSBotify commented May 25, 2023

OSBotify commented May 26, 2023

Fix: 18183 spinner persists to magic code section #19393

Fix: 18183 spinner persists to magic code section #19393

Conversation

tienifr commented May 22, 2023

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented May 22, 2023

aimane-chnaif commented May 23, 2023

tienifr commented May 23, 2023

tienifr commented May 23, 2023

aimane-chnaif commented May 23, 2023

aimane-chnaif commented May 23, 2023

aimane-chnaif commented May 23, 2023

tienifr commented May 23, 2023 • edited Loading

aimane-chnaif commented May 23, 2023 • edited Loading

tienifr commented May 23, 2023

aimane-chnaif commented May 23, 2023

tienifr commented May 23, 2023

aimane-chnaif commented May 24, 2023

aimane-chnaif commented May 24, 2023

Reviewer Checklist

Screenshots/Videos

aimane-chnaif left a comment

Choose a reason for hiding this comment

Julesssss left a comment

Choose a reason for hiding this comment

OSBotify commented May 24, 2023

OSBotify commented May 25, 2023

OSBotify commented May 25, 2023

OSBotify commented May 25, 2023

OSBotify commented May 26, 2023

tienifr commented May 23, 2023 •

edited

Loading

aimane-chnaif commented May 23, 2023 •

edited

Loading