27168 Deeplinking not working after logout #31316

lukemorawski · 2023-11-14T17:49:02Z

Details

This PR aims to fix a problem with deep links. When a user logs out and then tries to navigate using a deep link, the app does nothing. This is because the navigation action was dispatched before the nav tree changed. Navigation tree with all the protected routes (routes that are supposed to be accessible only by a logged in user) is rendered conditionally. After logging in, all the protected routes are rendered, but rebuilding the whole element tree takes a while.
To protect against that situation a helper method navContainsProtectedRoutes had been added to check if the nav state has the protected routes ready. This is done by checking if the routeNames array in the nav state contains any of the PROTECTED_SCREENS (a set of screen names that is available in the logged in state).
This is used by the waitForProtectedRoutes function, that returns a Promise which waits for the nav state to be in the logged in state and resolves immediately after this happens.
That is used used within the openReportFromDeepLink, that not only wait for the user to log in, but also now for the nav state to change.

Fixed Issues

$ #27168
PROPOSAL:

Tests

same as qa steps

Verify that no errors appear in the JS console

Offline tests

same as qa steps

QA Steps

_ open mobile app (android or ios)

log in
log out
run npx uri-scheme open "new-expensify://settings/profile/personal-details/date-of-birth" --ios (change to --android if your running an android app)
log in again
app should navigate to the screen from the link
Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

native.android.mov

Android: mWeb Chrome

web.android.mov

iOS: Native

native.ios.mov

iOS: mWeb Safari

web.ios.mov

MacOS: Chrome / Safari

web.desktop.mov

MacOS: Desktop

native.desktop.mov

src/libs/actions/PersonalDetails.ts

melvin-bot · 2023-11-15T12:47:53Z

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

narefyev91 · 2023-11-15T14:29:02Z

@lukemorawski there are some issues which i see between desktop and web (seems the same issues described here #29688 (comment))

Screen.Recording.2023-11-15.at.16.22.49.mov

Screen.Recording.2023-11-15.at.16.24.31.mov

lukemorawski · 2023-11-15T14:51:08Z

@narefyev91 can't really recreate that in dev mode as pasting a url starting from dev.new.expensify.com won't trigger a deep link that opens the dev desktop app. I was testing it in a rather roundabout way, by manually opening the link from the terminal and it worked.
Do you have any idea how to provoke the same behaviour in dev env?

lukemorawski · 2023-11-15T15:17:39Z

@narefyev91
ok, so it seems that this PR didn't introduced this issue.
I've switched to main and did the following test:

run the web app in safari
run the electron app
replaced the url origin from 'https://dev.new.expensify.com:8082' to 'new-expensify://' and retained the path
pressed enter - that's asking to open the electron app
electron app opens
Now, if the url path has a preciding / then everything is fine:
'new-expensify:///r/2712474404746581'
but if that / is missing then we get the issue you mentioned
'new-expensify://r/2712474404746581'
I'm not sure why that happens but IMHO it's something that is not related to the issue this PR tries to fix. More like a deep link url parsing.

narefyev91 · 2023-11-15T15:20:08Z

@narefyev91 ok, so it seems that this PR didn't introduced this issue. I've switched to main and did the following test:

run the web app in safari

run the electron app

replaced the url origin from 'https://dev.new.expensify.com:8082' to 'new-expensify://' and retained the path

pressed enter - that's asking to open the electron app

electron app opens
Now, if the url path has a preciding / then everything is fine:
'new-expensify:///r/2712474404746581'
but if that / is missing then we get the issue you mentioned
'new-expensify://r/2712474404746581'
I'm not sure why that happens but IMHO it's something that is not related to the issue this PR tries to fix. More like a deep link url parsing.

yup i also saw that issue already presented on main - but we need to be sure that this flow is not happened #29688 (comment) - because that were the main issues

lukemorawski · 2023-11-15T15:22:46Z

Also i do not see android mWeb video in your checklist

@narefyev91 android web video is under Android: mWeb Chrome details section in the description

lukemorawski · 2023-11-15T15:27:09Z

yup i also saw that issue already presented on main - but we need to be sure that this flow is not happened #29688 (comment) - because that were the main issues

@narefyev91 ok, but shouldn't this be a separate ticket then? changes in this PR where reverted last time, because it was falsy thought that it create a regression, when in fact, that regression (that you mention in the linked comment) was already present in the code.
I think the best solution would be to create a separate ticket for the issue from the comment and proceed with this one as it's quite critical and fixes issue unrelated to the previously mentioned comment

narefyev91 · 2023-11-15T15:32:26Z

@lukemorawski strange issue happened - when i just try to paste any url in the link for android mWeb - it shows me not found page - but if i rollback all your code - everything is working....

Screen.Recording.2023-11-15.at.17.26.22.mov

narefyev91 · 2023-11-15T15:39:09Z

Hmmm also i'm wondering - in all your videos you still use port 8082? Do you use old videos?

lukemorawski · 2023-11-15T15:42:48Z

web.android.working.url.change.mov

works for me. Actually your video uses the old version accessing the app in the browser. Now it's done using https. And it's still running on 8082

narefyev91 · 2023-11-15T15:50:55Z

web.android.working.url.change.mov
works for me. Actually your video uses the old version accessing the app in the browser. Now it's done using https. And it's still running on 8082

yup i using new one https://10.0.2.2:8082
Just changed the port - and still have issue

narefyev91 · 2023-11-15T16:36:57Z

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

8mb.video-cCZ-THl8R8j1.mp4

Mobile Web - Chrome

android-web.mp4

Mobile Web - Safari

ios-web.mp4

ios-web2.mp4

Desktop

desktop.mp4

iOS

ios2.mp4

8mb.video-dBA-vriQC3fw.mp4

Android

android.mp4

narefyev91

LGTM!
🎀 👀 🎀 C+ reviewed

OSBotify · 2023-11-19T17:06:19Z

✋ 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-11-22T00:50:36Z

🚀 Deployed to production by https://github.com/luacmartins in version: 1.4.1-13 🚀

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

Julesssss · 2023-11-22T13:10:39Z

This PR likely introduced this bug

s77rt · 2024-01-07T12:27:31Z

src/libs/actions/Report.js

+        Session.waitForUserSignIn().then(() => {
+            Navigation.waitForProtectedRoutes().then(() => {


This wait promise callback although it solves the original issue, it revealed a hidden bug #33001.

lukemorawski added 2 commits November 14, 2023 16:34

wait for protected routes in nav tree after sign in

5db2bf1

fix/crash when opening enable-payments from link when logged out

6328238

koko57 reviewed Nov 14, 2023

View reviewed changes

src/libs/actions/PersonalDetails.ts Outdated Show resolved Hide resolved

refactor/optional chaining and nullish coallescing instead of lodash

cc36503

lukemorawski marked this pull request as ready for review November 15, 2023 12:47

lukemorawski requested a review from a team as a code owner November 15, 2023 12:47

melvin-bot bot requested review from narefyev91 and removed request for a team November 15, 2023 12:47

narefyev91 approved these changes Nov 15, 2023

View reviewed changes

melvin-bot bot requested a review from thienlnam November 15, 2023 16:48

lukemorawski and others added 3 commits November 17, 2023 16:39

Merge branch 'main' into 27168-deeplinking_not_working_after_logout

4806f6f

prettier

d482fd5

linting

c583671

thienlnam approved these changes Nov 19, 2023

View reviewed changes

thienlnam merged commit ff4c947 into Expensify:main Nov 19, 2023
15 checks passed

os-botify bot mentioned this pull request Nov 20, 2023

Deploy Checklist: New Expensify 2023-11-20 #31556

Closed

90 tasks

tienifr mentioned this pull request Nov 22, 2023

[HOLD for payment 2023-12-04] [$500] Chat - Notification preferences page appears again after refreshing the page #31688

Closed

6 tasks

tienifr mentioned this pull request Nov 22, 2023

[$1000] Desktop-"Hmm.. it's not here" page appears when the app auto closes to update #28495

Closed

6 tasks

FitseTLT mentioned this pull request Nov 30, 2023

[$500] Distance - Request created with ../participants link returns app to request steps when going back #32274

Closed

6 tasks

huzaifa-99 mentioned this pull request Dec 13, 2023

Fix infinite loader when using attachments deeplink #24210

Closed

58 tasks

This was referenced Dec 13, 2023

[HOLD for payment 2024-01-11] [$500] Settings - Invalid contact method revisits not here page #33001

Closed

[HOLD for payment 2024-01-17] [$500] Request Money - If user reloads the IOU details page and go back, the same IOU page is shown #33205

Closed

lukemorawski mentioned this pull request Jan 2, 2024

[$500] Android - Deeplink navigation does not work for RHN links. #27168

Closed

6 tasks

s77rt reviewed Jan 7, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

27168 Deeplinking not working after logout #31316

27168 Deeplinking not working after logout #31316

lukemorawski commented Nov 14, 2023 •

edited

Loading

melvin-bot bot commented Nov 15, 2023

narefyev91 commented Nov 15, 2023 •

edited

Loading

lukemorawski commented Nov 15, 2023

lukemorawski commented Nov 15, 2023 •

edited

Loading

narefyev91 commented Nov 15, 2023 •

edited

Loading

lukemorawski commented Nov 15, 2023

lukemorawski commented Nov 15, 2023 •

edited

Loading

narefyev91 commented Nov 15, 2023 •

edited

Loading

narefyev91 commented Nov 15, 2023

lukemorawski commented Nov 15, 2023

narefyev91 commented Nov 15, 2023

narefyev91 commented Nov 15, 2023 •

edited

Loading

narefyev91 left a comment

OSBotify commented Nov 19, 2023

OSBotify commented Nov 22, 2023

Julesssss commented Nov 22, 2023

s77rt Jan 7, 2024

		Session.waitForUserSignIn().then(() => {
		Navigation.waitForProtectedRoutes().then(() => {

27168 Deeplinking not working after logout #31316

27168 Deeplinking not working after logout #31316

Conversation

lukemorawski commented Nov 14, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Nov 15, 2023

narefyev91 commented Nov 15, 2023 • edited Loading

lukemorawski commented Nov 15, 2023

lukemorawski commented Nov 15, 2023 • edited Loading

narefyev91 commented Nov 15, 2023 • edited Loading

lukemorawski commented Nov 15, 2023

lukemorawski commented Nov 15, 2023 • edited Loading

narefyev91 commented Nov 15, 2023 • edited Loading

narefyev91 commented Nov 15, 2023

lukemorawski commented Nov 15, 2023

narefyev91 commented Nov 15, 2023

narefyev91 commented Nov 15, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

narefyev91 left a comment

Choose a reason for hiding this comment

OSBotify commented Nov 19, 2023

OSBotify commented Nov 22, 2023

Julesssss commented Nov 22, 2023

s77rt Jan 7, 2024

Choose a reason for hiding this comment

lukemorawski commented Nov 14, 2023 •

edited

Loading

narefyev91 commented Nov 15, 2023 •

edited

Loading

lukemorawski commented Nov 15, 2023 •

edited

Loading

narefyev91 commented Nov 15, 2023 •

edited

Loading

lukemorawski commented Nov 15, 2023 •

edited

Loading

narefyev91 commented Nov 15, 2023 •

edited

Loading

narefyev91 commented Nov 15, 2023 •

edited

Loading