Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix Deeplinks except chat reports are not working on web #26856

Merged
merged 2 commits into from
Sep 8, 2023

Conversation

hungvu193
Copy link
Contributor

@hungvu193 hungvu193 commented Sep 6, 2023

Details

Fixed Issues

$ #26852
PROPOSAL: #26852 (comment)

Tests

Test RHP deeplink

  1. Log out
  2. Go to any app URL (/enable-payments) or /concierge or some other deeplink activated route
  3. Log in
  4. Verify that App navigates to that url after logging in.

Test conference deeplink new account

  1. Log out on web/ mWeb
  2. Go to /sbe route
  3. Sign in with account which is completely new (never used to sign in)
  4. Verify you are deeplinked to a new workspace chat and clicking Up in top left corner navigates you to the LHN

Test conference deeplink existing account

  1. Log out on web/ mWeb
  2. Go to /sbe route
  3. Sign in with the account from previous step (or any other account which already existed)
  4. Verify you are deeplinked to the workspace chat and clicking Up in top left corner navigates you to the LHN

Test Concierge deeplink

  1. Log out
  2. Go to /concierge route
  3. Sign in
  4. Verify you are deeplinked to a concierge chat and clicking Up in top left corner navigates you to the LHN

Test specific chat report deeplink

  1. Log out
  2. Go to /r/ route (some valid for the account)
  3. Sign in
  4. Verify you are deeplinked to that report chat and clicking Up in top left corner navigates you to the LHN (in narrow view)

Test specific chat report deeplink

  1. Log out
  2. Go to /r/ route (some valid for the account)
  3. Sign in
  4. Verify you are deeplinked to that report chat and clicking Up in top left corner navigates you to the LHN (in narrow view)

Test annonymous user claiming their account from public room

  1. Log out
  2. Go to /r/ route where this is a public_announce room which you can access as an anonymous user
  3. Take some action to go to sign in page to claim the account
  4. Sign in
  5. Verify you are correctly signed in and you can see the public chat room in the LHN
  • Verify that no errors appear in the JS console

Offline tests

This bug is not related to offline mode. No extra steps needed.

QA Steps

Same as tests

  • 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
Screen.Recording.2023-09-06.at.15.38.55.mov
Mobile Web - Chrome
RPReplay_Final1693989804.MP4
Mobile Web - Safari
RPReplay_Final1693989686.MP4
Desktop
Screen.Recording.2023-09-06.at.15.38.55.mov
iOS
Screen.Recording.2023-09-06.at.16.38.40.mov
Android
Screen.Recording.2023-09-06.at.16.07.13.mov

Only reset root with authenticated route
@hungvu193 hungvu193 changed the title Update NavigationRoot.js Fix Deeplinks except chat reports are not working on web Sep 6, 2023
@hungvu193 hungvu193 marked this pull request as ready for review September 6, 2023 08:51
@hungvu193 hungvu193 requested a review from a team as a code owner September 6, 2023 08:51
@melvin-bot melvin-bot bot requested review from eVoloshchak and removed request for a team September 6, 2023 08:51
@melvin-bot
Copy link

melvin-bot bot commented Sep 6, 2023

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

@hungvu193
Copy link
Contributor Author

@mountiny @adamgrzybowski PR is ready!

@mountiny mountiny requested review from parasharrajat and mountiny and removed request for eVoloshchak September 6, 2023 09:20
@mountiny
Copy link
Contributor

mountiny commented Sep 6, 2023

@hungvu193 the ios recording did not redirect anywhere

@mountiny
Copy link
Contributor

mountiny commented Sep 6, 2023

Updated the tests, could you also please run through them and make sure they work across platfroms? @hungvu193

@hungvu193
Copy link
Contributor Author

Updated the tests, could you also please run through them and make sure they work across platfroms? @hungvu193

Sure, let me give it a try

@parasharrajat
Copy link
Member

@hungvu193 Can you please explain the changes to me? Why were we reset the state there and now how has the behavior changed for that effect?

@hungvu193
Copy link
Contributor Author

hungvu193 commented Sep 6, 2023

@hungvu193 Can you please explain the changes to me? Why were we reset the state there and now how has the behavior changed for that effect?

According the comment here, We need to force state rehydration so the CustomRouter can add the CentralPaneNavigator route if necessary. However, this also accidentally clear the pending route when user tried to login from deeplink, which made the app couldn't navigate to that route after logging in. My PR prevented that happened.

@parasharrajat
Copy link
Member

It does not give any hint. I am going to test it.

@hungvu193
Copy link
Contributor Author

hungvu193 commented Sep 6, 2023

@mountiny

From route:

from.route.mov

From sbe:

sbe.mwebmp4.mov

From anonymous user:

anonymous.mov

SAATR:

Screen.Recording.2023-09-06.at.17.20.20.mov

@parasharrajat
Copy link
Member

parasharrajat commented Sep 6, 2023

Found a bug:

Can't reproduce it now. May be just a glitch.

Details: Navigating to the Sbe route after you are logged in directly via URL shows you the anonymous report view for the SBE room with all the chats of the logined user.

  1. Login with a user who is not a member of Sbe Rooms.
  2. Now, change the url and use /sbe.
  3. Observe whether it takes you to the Sbe room chat or not.

@hungvu193
Copy link
Contributor Author

Found a bug:

@parasharrajat can you post it in our conversation in the original issue here? #26852

@parasharrajat
Copy link
Member

Added details. Probably a glitch but how?

@parasharrajat
Copy link
Member

parasharrajat commented Sep 6, 2023

Screenshots

🔲 iOS / native

Screen.Recording.2023-09-06.at.4.27.03.PM.mov
Screen.Recording.2023-09-06.at.4.24.21.PM.mov
Screen.Recording.2023-09-06.at.7.06.52.PM.mov
Screen.Recording.2023-09-06.at.7.08.55.PM.mov

🔲 iOS / Safari

Screen.Recording.2023-09-06.at.4.22.54.PM.mov

🔲 MacOS / Desktop

Screen.Recording.2023-09-08.at.4.09.34.AM.mov

🔲 MacOS / Chrome

Screen.Recording.2023-09-06.at.4.03.03.PM.mov

🔲 Android / Chrome

Screen.Recording.2023-09-08.at.3.55.07.AM.mov
Screen.Recording.2023-09-08.at.4.11.46.AM.mov

🔲 Android / native

Ignore the error, I accessed an internal link.

Screen.Recording.2023-09-08.at.4.17.45.AM.mov

@mountiny
Copy link
Contributor

mountiny commented Sep 6, 2023

@hungvu193 @parasharrajat for the concierge, sbe and saastr tests, please also adding theese:

  1. It must be completely new account, which never signed up before
  2. When deeplinked for the first time, try clicking the Up button in to left corner to navigate back to the LHN, this was broken before and fixed recently
  3. Also try with account which already existed

@mountiny
Copy link
Contributor

mountiny commented Sep 6, 2023

Clarified that in the test steps

@parasharrajat
Copy link
Member

parasharrajat commented Sep 6, 2023

I am seeing double navigation animation via deeplink on iOS. Checking this on main.

Screen.Recording.2023-09-06.at.4.31.16.PM.mov

@hungvu193
Copy link
Contributor Author

I am seeing double navigation animation via deeplink on iOS. Checking this on main.

Screen.Recording.2023-09-06.at.4.31.16.PM.mov

@parasharrajat that's existing issue and being addressed here:
#23441

@hungvu193
Copy link
Contributor Author

hungvu193 commented Sep 6, 2023

@hungvu193 @parasharrajat for the concierge, sbe and saastr tests, please also adding theese:

  1. It must be completely new account, which never signed up before
  2. When deeplinked for the first time, try clicking the Up button in to left corner to navigate back to the LHN, this was broken before and fixed recently
  3. Also try with account which already existed

Verified it's working. I'll be afk for next couple of hours, but can still chat, please tag me if you guys have any questions. Thanks!
Posted video to slack thread:
https://expensify.slack.com/archives/C049HHMV9SM/p1693998649036349

@mountiny
Copy link
Contributor

mountiny commented Sep 6, 2023

Given this might be a bigger change I prefer to test thoroughly

@Julesssss
Copy link
Contributor

Hey @parasharrajat can you please tag me on the Android deep link not working when app killed bug you created please, it's odd but sounds like an issue in the JS logic.

@parasharrajat
Copy link
Member

I haven't reported it yet. I will do that in 15-20 mins.

@parasharrajat
Copy link
Member

parasharrajat commented Sep 7, 2023

@mountiny What do you think about that bug #26856 (comment)?

I also reported it on Slack https://expensify.slack.com/archives/C049HHMV9SM/p1694080489810799

@mountiny
Copy link
Contributor

mountiny commented Sep 7, 2023

@parasharrajat I think thats same as the enable-payments? Does that work in this case? Why would it be different?

@parasharrajat
Copy link
Member

parasharrajat commented Sep 7, 2023

yes. It is same.

@hungvu193
Copy link
Contributor Author

I think we can move forward with this PR @mountiny @parasharrajat

@parasharrajat
Copy link
Member

Yes, Doing the final tests now.

Copy link
Member

@parasharrajat parasharrajat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is a deep link issue as posted here on Android but the rest is working.

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.

🎀 👀 🎀 C+ reviewed

Copy link
Contributor

@mountiny mountiny left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe this is important enough to move through the merge freeze, thanks everyone 🙇

@mountiny mountiny merged commit 7c9fc84 into Expensify:main Sep 8, 2023
14 checks passed
@OSBotify
Copy link
Contributor

OSBotify commented Sep 8, 2023

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

@hoangzinh
Copy link
Contributor

Hey team, It seems that deeplinks doesn't work in Native app (IOS) in latest main. Just wanna raise if you have same experience

@parasharrajat
Copy link
Member

@hoangzinh Steps?

@hoangzinh
Copy link
Contributor

@parasharrajat The 1st test case in the GH description

Test RHP deeplink

  1. Log out
  2. Go to any app URL (/enable-payments) or /concierge or some other deeplink activated route
  3. Log in
  4. Verify that App navigates to that url after logging in.
Screen.Recording.2023-09-10.at.21.42.16.mp4

@parasharrajat
Copy link
Member

Sounds like this https://expensify.slack.com/archives/C049HHMV9SM/p1694080489810799

@hoangzinh
Copy link
Contributor

Thanks @parasharrajat

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/mountiny in version: 1.3.67-0 🚀

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

@kavimuru
Copy link

@hungvu193 desktop is failing with this issue #25790 (comment).

@parasharrajat
Copy link
Member

@kavimuru that might be intended behaviour #25790 (comment)

@kavimuru
Copy link

@parasharrajat PR is to test with log out. How should we test this one?

@kavimuru
Copy link

@parasharrajat This is the video

26856_Desktop.mp4

@parasharrajat
Copy link
Member

We are trying to test that deep link URLs open the correct page on the app itself. I understand that on desktop, we also show a prompt to natively installed app but that is something out of the scope of this PR/issue. The related bug might be another issue.

Also, in #25790 (comment), It was confirmed that while the user is logged out we don't show the native app prompt for the desktop app.

Let me know if you still have some doubts.

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/AndrewGable in version: 1.3.67-3 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/mountiny in version: 1.3.68-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/Julesssss in version: 1.3.68-17 🚀

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants