Android - Deeplink navigation does not work for RHN links. #28278

lukemorawski · 2023-09-26T19:12:46Z

Details

This PR addresses the issue of unhandled deep links invoked when the app is in the unauthenticated state.
Even though the app was defering navigation to the deep link route until the user is authenticated, that still was not enough.
Turns out that immediately after the auth flag changes, the nav tree is not done rebuilding and the protected routes are not yet available for navigation.
To address that issue, the app now waits not only for user to log in, but also for the nav state to contain protected routes to continue with the deffered navigation action.
This is done using a dedicated helper function that returns a promise that resolves when the navigation state reaches desired state.

Fixed Issues

$ #27168
PROPOSAL: no proposal

Tests

Open the app on Android.
Log out if already logined.
Use deeplink new-expensify://settings/profile/personal-details/date-of-birth. Please use the domain/scheme that works for you. you can also use staging url if testing staging app.
Now, login with a user.
Verify that no errors appear in the JS console

Offline tests

QA Steps

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
- If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
- 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 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 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.desktop.mov

Mobile Web - Chrome

web.android.mov

Mobile Web - Safari

web.ios.mov

Desktop

web.desktop.mov

iOS

native.ios.mov

Android

native.android.mov

melvin-bot · 2023-09-27T08:46:51Z

@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-09-28T16:45:13Z

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

android-web.mov

Mobile Web - Safari

ios-web.mov

Desktop

desktop.mov

iOS

ios.mov

Android

android.mov

narefyev91

LGMT!
🎀 👀 🎀 C+ reviewed

melvin-bot · 2023-09-28T16:46:05Z

We did not find an internal engineer to review this PR, trying to assign a random engineer to #27168 as well as to this PR... Please reach out for help on Slack if no one gets assigned!

narefyev91 · 2023-09-29T07:47:57Z

@lukemorawski please re-base from main branch - jest unit tests 3 was fixed on main

lukemorawski · 2023-09-29T09:15:47Z

@narefyev91 rebased!

francoisl · 2023-10-02T18:07:35Z

(Yuwen is OOO, I'll take over this on his behalf)

Looks like there's a small conflict, can you resolve it so we can merge please @lukemorawski?

lukemorawski · 2023-10-03T09:11:51Z

@francoisl Sorry, I was ooo yesterday. Will resolve today.

…rhn_links

francoisl

cc @thienlnam FYI - I'm just seeing Yuwen had reassigned you to the issue

francoisl · 2023-10-05T00:15:55Z

src/libs/Navigation/Navigation.js

+ * Waits for the navigation state to contain protected routes (specifically 'Concierge').
+ * If the navigation is in a state, where protected routes are available, the promise will resolve immediately.


Just to make sure I understand, is "protected route" a new concept we're introducing? I'm not sure I understand what it has to do with Concierge specifically.

nope, it's just the way routes hidden behind the auth process are called. Since Concierge is the one of the most important screens that is available to users after logging in, I'm using it to detect the change and readiness of the navigation state. In simple words - when Concierge is present as one of the available routes in the nav state, this means that app is showing protected routes.
Main cause of the whole bug was, that the app was trying to navigate to a protected route immediately after logging in, but the navigation was not ready yet and it was throwing an error.

Is there another way we can wait for navigation to finish? I'm not sure I like the idea of checking if Concierge is an available route before allowing navigation. There might be situations in the future where the Concierge route is not available (I.e anonymous accounts)

I understand, though with current nav setup it's hard to come up with a better way. If the navigation was done using protected route guard components, that would be easier (or even unnecessary), but there's a conditional nav tree rendering in <AppNavigator /> component and the nav state is not immediately following the rendering state. The other way around this problem would be to introduce some global (app wide) state, a flag perhaps, that would indicate the readiness of the nav tree. This would require every protected page, and every public page to update this flag on it's mounting. So when a protected page (screen) is loaded then it updates this new flag to, lets say true, and when a public screen is loaded it updates this flag to false. But that requires a lot of additional code all over the app. That would be the most robust approach I guess.
The other would be to create a separate const of protected routes, that would be spreaded to the const of other screens in the SCREENS.ts, but it's a bit more tricky. Currently checking that option.

thienlnam · 2023-10-06T10:28:17Z

src/libs/Navigation/Navigation.js

+ * Waits for the navigation state to contain protected routes (specifically 'Concierge').
+ * If the navigation is in a state, where protected routes are available, the promise will resolve immediately.


Is there another way we can wait for navigation to finish? I'm not sure I like the idea of checking if Concierge is an available route before allowing navigation. There might be situations in the future where the Concierge route is not available (I.e anonymous accounts)

…rhn_links

lukemorawski · 2023-10-10T10:17:35Z

@thienlnam I've improved a bit the way to recognise the navigation has transitioned to the authorised state. Instead of checking if Concierge screen is amongst the available route, the app now check for multiple protected routes. They are in a separate const in the SCREENS.ts, that is spread to the default export, which will ensure consistency.

thienlnam

Thanks, I like this solution more than just checking Concierge - looks like just the comments are now slightly outdated but rest looks good

thienlnam · 2023-10-10T17:51:51Z

src/libs/Navigation/Navigation.js

+}
+
+/**
+ * Waits for the navigation state to contain protected routes (specifically 'Concierge').


Comments need to be updated now

lukemorawski · 2023-10-11T14:30:36Z

@thienlnam Fixed the comment!

…rhn_links

thienlnam

Great, thanks!

OSBotify · 2023-10-12T17:07:12Z

✋ 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-10-13T21:12:22Z

🚀 Deployed to staging by https://github.com/thienlnam in version: 1.3.84-0 🚀

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

OSBotify · 2023-10-16T21:13:11Z

🚀 Deployed to production by https://github.com/francoisl in version: 1.3.84-10 🚀

platform	result
🤖 android 🤖	skipped 🚫
🖥 desktop 🖥	skipped 🚫
🍎 iOS 🍎	skipped 🚫
🕸 web 🕸	skipped 🚫

OSBotify · 2023-10-16T21:49:31Z

🚀 Deployed to production by https://github.com/francoisl in version: 1.3.84-10 🚀

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

OSBotify · 2023-10-16T21:52:27Z

🚀 Deployed to staging by https://github.com/thienlnam in version: 1.3.85-0 🚀

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

OSBotify · 2023-10-17T23:17:12Z

🚀 Deployed to production by https://github.com/francoisl in version: 1.3.85-4 🚀

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

lukemorawski added 2 commits September 26, 2023 16:31

fix

51f9f74

linting

e9330ea

lukemorawski marked this pull request as ready for review September 27, 2023 08:46

lukemorawski requested a review from a team as a code owner September 27, 2023 08:46

melvin-bot bot requested review from narefyev91 and removed request for a team September 27, 2023 08:46

narefyev91 approved these changes Sep 28, 2023

View reviewed changes

melvin-bot bot requested a review from yuwenmemon September 28, 2023 16:46

yuwenmemon previously approved these changes Sep 29, 2023

View reviewed changes

francoisl self-requested a review October 2, 2023 18:07

Merge branch 'main' into 27168-deeplink_navigation_does_not_work_for_…

098bb11

…rhn_links

lukemorawski dismissed yuwenmemon’s stale review via 098bb11 October 4, 2023 07:33

francoisl reviewed Oct 5, 2023

View reviewed changes

thienlnam requested changes Oct 6, 2023

View reviewed changes

lukemorawski and others added 2 commits October 10, 2023 11:33

checking for multiple protected screens

958b028

Merge branch 'main' into 27168-deeplink_navigation_does_not_work_for_…

44be36d

…rhn_links

linting

f2d683f

lukemorawski requested a review from thienlnam October 10, 2023 10:36

thienlnam reviewed Oct 10, 2023

View reviewed changes

comment fix

6d499eb

lukemorawski requested a review from thienlnam October 11, 2023 14:30

Merge branch 'main' into 27168-deeplink_navigation_does_not_work_for_…

101790b

…rhn_links

thienlnam approved these changes Oct 12, 2023

View reviewed changes

thienlnam merged commit d2c8456 into Expensify:main Oct 12, 2023
13 checks passed

OSBotify mentioned this pull request Oct 13, 2023

Deploy Checklist: New Expensify 2023-10-13 #29585

Closed

97 tasks

francoisl added a commit that referenced this pull request Oct 16, 2023

Revert #28278

73d966d

This was referenced Oct 16, 2023

[CP Staging] Revert PR 28278 #29706

Merged

dl desktop error fix #29688

Closed

OSBotify mentioned this pull request Oct 16, 2023

Deploy Checklist: New Expensify 2023-10-16 #29717

Closed

melvin-bot bot mentioned this pull request Oct 16, 2023

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

Closed

6 tasks

huzaifa-99 mentioned this pull request Oct 25, 2023

Fix infinite loader when using attachments deeplink #24210

Closed

58 tasks

mallenexpensify mentioned this pull request Nov 6, 2023

[$1000] Web - A non-stoping spinner is displayed when opening an image previewer carousal with a deep link #23899

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Android - Deeplink navigation does not work for RHN links. #28278

Android - Deeplink navigation does not work for RHN links. #28278

lukemorawski commented Sep 26, 2023

melvin-bot bot commented Sep 27, 2023

narefyev91 commented Sep 28, 2023

narefyev91 left a comment

melvin-bot bot commented Sep 28, 2023

narefyev91 commented Sep 29, 2023

lukemorawski commented Sep 29, 2023

francoisl commented Oct 2, 2023

lukemorawski commented Oct 3, 2023

francoisl left a comment

francoisl Oct 5, 2023

lukemorawski Oct 5, 2023 •

edited

Loading

thienlnam Oct 6, 2023

lukemorawski Oct 9, 2023

thienlnam Oct 6, 2023

lukemorawski commented Oct 10, 2023

thienlnam left a comment

thienlnam Oct 10, 2023

lukemorawski commented Oct 11, 2023

thienlnam left a comment

OSBotify commented Oct 12, 2023

OSBotify commented Oct 13, 2023

OSBotify commented Oct 16, 2023

OSBotify commented Oct 16, 2023

OSBotify commented Oct 16, 2023

OSBotify commented Oct 17, 2023

		* Waits for the navigation state to contain protected routes (specifically 'Concierge').
		* If the navigation is in a state, where protected routes are available, the promise will resolve immediately.

Android - Deeplink navigation does not work for RHN links. #28278

Android - Deeplink navigation does not work for RHN links. #28278

Conversation

lukemorawski commented Sep 26, 2023

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Sep 27, 2023

narefyev91 commented Sep 28, 2023

Reviewer Checklist

Screenshots/Videos

narefyev91 left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Sep 28, 2023

narefyev91 commented Sep 29, 2023

lukemorawski commented Sep 29, 2023

francoisl commented Oct 2, 2023

lukemorawski commented Oct 3, 2023

francoisl left a comment

Choose a reason for hiding this comment

francoisl Oct 5, 2023

Choose a reason for hiding this comment

lukemorawski Oct 5, 2023 • edited Loading

Choose a reason for hiding this comment

thienlnam Oct 6, 2023

Choose a reason for hiding this comment

lukemorawski Oct 9, 2023

Choose a reason for hiding this comment

thienlnam Oct 6, 2023

Choose a reason for hiding this comment

lukemorawski commented Oct 10, 2023

thienlnam left a comment

Choose a reason for hiding this comment

thienlnam Oct 10, 2023

Choose a reason for hiding this comment

lukemorawski commented Oct 11, 2023

thienlnam left a comment

Choose a reason for hiding this comment

OSBotify commented Oct 12, 2023

OSBotify commented Oct 13, 2023

OSBotify commented Oct 16, 2023

OSBotify commented Oct 16, 2023

OSBotify commented Oct 16, 2023

OSBotify commented Oct 17, 2023

lukemorawski Oct 5, 2023 •

edited

Loading