[CP Staging] fix: wait for navigation ready state before signing in #35827

aswin-s · 2024-02-05T15:58:08Z

Details

This PR fixes an issue were user gets stuck on an infinite loop while trying to sign in using deep link on native devices.

Fixed Issues

$ #35745
PROPOSAL: #35745 (comment)

Tests

Open the app on an iOS or Android device
Enter the email and tap "Continue"
Tap on the link received in email to sign in to the app
Verify that sign-in is successful

For Developer testing, follow below steps.

iOS

xcrun simctl openurl booted 'new-expensify://v/xxx/yyy'

Android

adb shell am start -a android.intent.action.VIEW -d "new-expensify://v/xxx/yyy"

Verify that no errors appear in the JS console

Offline tests

Sign in needs active internet connection

QA Steps

Open the app on an iOS or Android device
Enter the email and tap "Continue"
Tap on the link received in email to sign in to the app
Verify that sign-in is successful

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

android_out.mp4

Android: mWeb Chrome

android-web_out.mp4

iOS: Native

ios_out.mp4

iOS: mWeb Safari

ios-mweb_out.mp4

MacOS: Chrome / Safari

web_out.mp4

MacOS: Desktop

desktop_out.mp4

situchan · 2024-02-05T16:18:26Z

The code change affects only native platforms so I think it's fine to test only android and iOS deeplinks.

melvin-bot · 2024-02-05T16:18:37Z

@Gonals 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]

situchan · 2024-02-05T16:20:57Z

Please add Tests step

iOS deeplink test:

xcrun simctl openurl booted 'new-expensify://v/xxx/yyy'

android deeplink test:

adb shell am start -a android.intent.action.VIEW -d "new-expensify://v/xxx/yyy"

aswin-s · 2024-02-05T16:26:10Z

Please add Tests step

Updated test cases.

situchan · 2024-02-05T16:29:53Z

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: 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. 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(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 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 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 Design label so the design team can review the changes.
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

Android: Native

Screen.Recording.2024-02-05.at.10.28.38.PM.mov

Android: mWeb Chrome

iOS: Native

Screen.Recording.2024-02-05.at.10.23.53.PM.mov

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

situchan · 2024-02-05T16:32:55Z

@aswin-s I am still getting infinite loading when invalid link is entered
i.e. change last number (yyy) to incorrect one

Screen.Recording.2024-02-05.at.10.32.29.PM.mov

aswin-s · 2024-02-05T16:42:03Z

Checking

aswin-s · 2024-02-05T17:09:26Z

@situchan Looks like this situation was never handled on native platform? I could see the same scenario handled for web though.

App/src/pages/ValidateLoginPage/index.website.tsx

Line 55 in a1b33ef

    
           {autoAuthState === CONST.AUTO_AUTH_STATE.FAILED && <ExpiredValidateCodeModal />}

situchan · 2024-02-05T17:10:59Z

Can you check playstore/appstore apps? If it's not reproducible on production, I think it should be fixed

situchan · 2024-02-05T18:06:22Z

src/pages/ValidateLoginPage/index.tsx

+        Navigation.isNavigationReady().then(() => {
+            Navigation.goBack();
+        });
+    }, [session?.autoAuthState]);


Were you able to find the root cause? How come it used to work before?

I think it is because of navigation refactor. User should be redirected back to sign-in page if code validation fails.

I know it's from navigation refactor. But wanted to know exactly which code caused this.
This file was not changed recently

aswin-s · 2024-02-05T18:07:44Z

@situchan Fixed the issue. I've made it just like how it used to be on production.

fix_out.mp4

marcaaron · 2024-02-05T18:16:00Z

waiting for @situchan I'll take over the internal review for @Gonals since they are probably offline by now.

situchan · 2024-02-05T18:17:02Z

Failure case also works well with the latest change

Screen.Recording.2024-02-06.at.12.15.51.AM.mov

situchan

The root cause of failure case is still not clear yet but the fix looks good to me and tests well.
Given this is urgent as deploy blocker, approving

OSBotify · 2024-02-05T18:25:21Z

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

[CP Staging] fix: wait for navigation ready state before signing in (cherry picked from commit e9f7b81)

OSBotify · 2024-02-05T18:51:29Z

🚀 Cherry-picked to staging by https://github.com/marcaaron in version: 1.4.36-3 🚀

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

@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes.

OSBotify · 2024-02-05T22:55:00Z

🚀 Deployed to production by https://github.com/marcaaron in version: 1.4.36-5 🚀

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

fix: wait for navigation ready state before signing in

dbc4204

aswin-s mentioned this pull request Feb 5, 2024

[HOLD for payment 2024-02-14] [$500] Login - Blank screen and infinite spinner when logging in using magic link #35745

Closed

6 tasks

mountiny requested a review from situchan February 5, 2024 16:04

mountiny assigned aswin-s Feb 5, 2024

mountiny changed the title ~~fix: wait for navigation ready state before signing in~~ [CP Staging] fix: wait for navigation ready state before signing in Feb 5, 2024

aswin-s marked this pull request as ready for review February 5, 2024 16:18

aswin-s requested a review from a team as a code owner February 5, 2024 16:18

melvin-bot bot removed the request for review from a team February 5, 2024 16:18

melvin-bot bot requested a review from Gonals February 5, 2024 16:18

fix: redirect to signin page on validation failure

484116c

situchan reviewed Feb 5, 2024

View reviewed changes

aswin-s requested a review from situchan February 5, 2024 18:07

marcaaron requested review from marcaaron and removed request for Gonals February 5, 2024 18:16

situchan approved these changes Feb 5, 2024

View reviewed changes

marcaaron approved these changes Feb 5, 2024

View reviewed changes

marcaaron merged commit e9f7b81 into Expensify:main Feb 5, 2024
19 checks passed

OSBotify pushed a commit that referenced this pull request Feb 5, 2024

Merge pull request #35827 from aswin-s/fix/issue-35745

7df3316

[CP Staging] fix: wait for navigation ready state before signing in (cherry picked from commit e9f7b81)

github-actions bot mentioned this pull request Feb 5, 2024

Deploy Checklist: New Expensify 2024-02-02 #35673

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[CP Staging] fix: wait for navigation ready state before signing in #35827

[CP Staging] fix: wait for navigation ready state before signing in #35827

aswin-s commented Feb 5, 2024 •

edited

Loading

situchan commented Feb 5, 2024

melvin-bot bot commented Feb 5, 2024

situchan commented Feb 5, 2024

aswin-s commented Feb 5, 2024

situchan commented Feb 5, 2024

situchan commented Feb 5, 2024

aswin-s commented Feb 5, 2024

aswin-s commented Feb 5, 2024

situchan commented Feb 5, 2024

situchan Feb 5, 2024

aswin-s Feb 5, 2024

situchan Feb 5, 2024

aswin-s commented Feb 5, 2024

marcaaron commented Feb 5, 2024

situchan commented Feb 5, 2024

situchan left a comment

OSBotify commented Feb 5, 2024

OSBotify commented Feb 5, 2024

OSBotify commented Feb 5, 2024

[CP Staging] fix: wait for navigation ready state before signing in #35827

[CP Staging] fix: wait for navigation ready state before signing in #35827

Conversation

aswin-s commented Feb 5, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

situchan commented Feb 5, 2024

melvin-bot bot commented Feb 5, 2024

situchan commented Feb 5, 2024

aswin-s commented Feb 5, 2024

situchan commented Feb 5, 2024

Reviewer Checklist

Screenshots/Videos

situchan commented Feb 5, 2024

aswin-s commented Feb 5, 2024

aswin-s commented Feb 5, 2024

situchan commented Feb 5, 2024

situchan Feb 5, 2024

Choose a reason for hiding this comment

aswin-s Feb 5, 2024

Choose a reason for hiding this comment

situchan Feb 5, 2024

Choose a reason for hiding this comment

aswin-s commented Feb 5, 2024

marcaaron commented Feb 5, 2024

situchan commented Feb 5, 2024

situchan left a comment

Choose a reason for hiding this comment

OSBotify commented Feb 5, 2024

OSBotify commented Feb 5, 2024

OSBotify commented Feb 5, 2024

aswin-s commented Feb 5, 2024 •

edited

Loading