Fix magic code expired is shown briefly#49042
Conversation
|
@parasharrajat 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] |
| if (autoAuthState === CONST.AUTO_AUTH_STATE.FAILED) { | ||
| Session.clearAutoAuthState(); | ||
| } | ||
| } |
There was a problem hiding this comment.
The solution here is a bit different from the proposal. Instead of clearing the autoAuthState when pressing "request one here" text button, I clear it when the page function is called for the first time.
I do this because on Desktop, there is no "request one here" text button, similar to native. Instead, the ValidateLoginPage is closed. So, the issue still happens if we:
- Open an expired magic link
- User is redirected back to the sign-in page with a form error shown
- Open the new magic link
- Magic code expired is shown briefly
I tried clearing it in an useEffect, but the magic code expired is still shown briefly.
| // If the magic link was previously expired (FAILED), we want to clear the failed state so the magic code expired won't show briefly. | ||
| if (firstRenderRef.current) { | ||
| firstRenderRef.current = false; | ||
| if (autoAuthState === CONST.AUTO_AUTH_STATE.FAILED) { | ||
| Session.clearAutoAuthState(); | ||
| } | ||
| } |
There was a problem hiding this comment.
what if we repeat the same for a couple of times? Will this work?
There was a problem hiding this comment.
I just tested refreshing the page multiple times and turns out it's still not fast enough to clear the autoAuthState before the view is rendered.
web.mp4
There was a problem hiding this comment.
Are you saying that need a new solution and existing does not work?
There was a problem hiding this comment.
Yes, I've pushed a new fix
| key: ONYXKEYS.SESSION, | ||
| selector: (session) => session?.autoAuthState, | ||
| initWithStoredValues: false, | ||
| }, |
There was a problem hiding this comment.
Instead of clearing the autoAuthState on mounted, I connect a new onyx key specifically fo fetch the autoAuthState with initWithStoredValues as false so the value is always undefined at first render.
| const isSignedIn = !!session?.authToken && session?.authTokenType !== CONST.AUTH_TOKEN_TYPES.ANONYMOUS; | ||
| // We don't want the previous autoAuthState affects the rendering of the current magic link page, so the autoAuthState prop sets initWithStoredValues as false, | ||
| // except if the user is signed in because the page will be remounted when successfully signed in as explained in Session.initAutoAuthState. | ||
| const autoAuthState = isSignedIn ? session?.autoAuthState : autoAuthStateProp; |
There was a problem hiding this comment.
Having autoAuthState as undefined initially at first render works fine except when the user is successfully logged in from the magic link.
There was a problem hiding this comment.
The rest of the changes is just renaming.
|
g### Screenshots 🔲 iOS / native17.09.2024_03.31.36_REC.mp4🔲 iOS / Safari17.09.2024_02.23.24_REC.mp4🔲 MacOS / Desktop17.09.2024_03.35.23_REC.mp4🔲 MacOS / Chrome17.09.2024_02.20.37_REC.mp4🔲 Android / Chrome17.09.2024_02.28.08_REC.mp4🔲 Android / native17.09.2024_03.51.50_REC.mp4 |
parasharrajat
left a comment
There was a problem hiding this comment.
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 Issuessection 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
Testssection - I verified the steps for Staging and/or Production testing are in the
QA stepssection - 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 verified the steps for local testing are in the
- 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: mWeb Chrome
- iOS: Native
- iOS: mWeb 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.
toggleReportand notonIconClick). - 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 Copylabel 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
- 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.
- 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 usingAvatarhave 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
thisproperly so there are no scoping issues (i.e. foronClick={this.submit}the methodthis.submitshould be bound tothisin the constructor) - Any internal methods bound to
thisare necessary to be bound (i.e. avoidthis.submit = this.submit.bind(this);ifthis.submitis never passed to a component event handler likeonClick) - 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(theme.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
Avataris modified, I verified thatAvataris 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 the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
- If the PR modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added
Designlabel so the design team can review the changes.
- If a new page is added, I verified it's using the
ScrollViewcomponent to make it scrollable when more elements are added to the page. - If the
mainbranch was merged into this PR after a review, I tested again and verified the outcome was still expected according to theTeststeps. - I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.
🎀 👀 🎀 C+ reviewed
|
I think we should fix it while we're here
|
|
@bernhardoj cc |
|
@MonilBhavsar oh, I'm afraid we can't do that right now because |
|
Could you please elaborate more about the bug. Is it being worked anywhere? |
|
@MonilBhavsar using I'm not aware if it is being worked anywhere. |
|
@bernhardoj Did you raise this on Slack yet? |
|
Nope. |
|
Could you please do that as you have better understanding of the problem? |
|
Brought up in the slack for some more eyes https://expensify.slack.com/archives/C01GTK53T8Q/p1727125031666679?thread_ts=1726169039.084589&cid=C01GTK53T8Q |
|
The Onyx Bump PR is ready to review -> #49857 |
|
@bernhardoj The Onyx Bump PR was merged 🚀 |
|
@fabioh8010 Thanks! @parasharrajat @MonilBhavsar migrated to useOnyx |
|
@MonilBhavsar Bump. |
|
✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release. |
|
🚀 Deployed to staging by https://github.com/MonilBhavsar in version: 9.0.45-1 🚀
|
|
🚀 Deployed to production by https://github.com/thienlnam in version: 9.0.45-4 🚀
|
Details
If we previously open an expired magic code link, then opens another magic link, a magic code expired view will be shown briefly.
Fixed Issues
$ #47883
PROPOSAL: #47883 (comment)
Tests
Same as QA Steps
Offline tests
Same as QA Steps
QA Steps
PR Author Checklist
### Fixed Issuessection aboveTestssectionOffline stepssectionQA stepssectiontoggleReportand notonIconClick)myBool && <MyComponent />.src/languages/*files and using the translation methodSTYLE.md) were followedAvatar, I verified the components usingAvatarare working as expected)StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))Avataris modified, I verified thatAvataris working as expected in all cases)Designlabel and/or tagged@Expensify/designso the design team can review the changes.ScrollViewcomponent to make it scrollable when more elements are added to the page.mainbranch was merged into this PR after a review, I tested again and verified the outcome was still expected according to theTeststeps.Screenshots/Videos
Android: Native
android.mp4
Android: mWeb Chrome
android.mweb.mp4
iOS: Native
ios.mp4
iOS: mWeb Safari
ios.mweb.mp4
MacOS: Chrome / Safari
web.magic.code.mp4
MacOS: Desktop
desktop.mp4