Fix/deeplinks when app in background #26073

kubabutkiewicz · 2023-08-28T11:57:45Z

Deeplink to every screen based on linking config when opening app from background

Details

To action responsible for navigating users from deeplinks when user is logged out added posibility to navigate to all routes not only specific ones

Fixed Issues

$ #23745
PROPOSAL: #23745 (comment)

Tests

Make sure app is in the background mode
Make sure you are logged out
Open app from whatever deeplink
Log in
You should be redirected to screen which you provided into deeplink

Verify that no errors appear in the JS console

Offline tests

QA Steps

Open app using deeplink
App should redirect you to correct screen

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

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

ios.mp4

Android

android.mp4

…pp from deeplink

melvin-bot · 2023-08-28T11:58:44Z

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

mollfpr

Thanks for the PR @kubabutkiewicz

Could you explain the different of SidebarUtils.isSidebarLoadedReady with Session.waitForUserSignIn?

mollfpr · 2023-08-28T16:15:57Z

src/libs/actions/Session/index.js

            const reportID = ReportUtils.getReportIDFromLink(url);
            if (reportID) {
-                Report.setLastOpenedPublicRoom(reportID);
+                Onyx.merge(ONYXKEYS.LAST_OPENED_PUBLIC_ROOM_ID, reportID);


Any reason we are doing this?

Yes , according to onyx documentation set should be used only when deleting the key from store or resetting object or array of data. In our case we are only storing primitive value so to that case better is to use merge.

Also we are removing Report.setLastOpenedPublicRoom(reportID) because it was causing circular dependency

kubabutkiewicz · 2023-08-29T08:22:03Z

Could you explain the different of SidebarUtils.isSidebarLoadedReady with Session.waitForUserSignIn?

Yeah sure, in our case we just want to wait with navigation till user is signed in so its more clear to create such a method also if we will use SidebarUtils.isSidebarLoadedReady it will take more time to navigate user since for this its need to happen more things inside the app when sidebar will be fully loaded

mollfpr · 2023-08-29T14:25:42Z

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 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 reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

26073.Web.mp4

Mobile Web - Chrome

26073.mWeb-Chrome.mp4

Mobile Web - Safari

26073.mWeb-Safari.mp4

Desktop

26073.Desktop.mp4

iOS

26073.iOS.mp4

Android

26073.Android.mp4

mollfpr · 2023-08-29T14:46:30Z

Thanks @kubabutkiewicz, for the explanation.

Generally, the code looks good, and the test results are working fine. I tried the case from this PR #20740; the PR introduced the SidebarUtils.isSidebarLoadedReady. On that test, the result does not show the concierge chat but the not found page.

kubabutkiewicz · 2023-08-30T12:25:09Z

Hi @mollfpr

Yes indeed there is something wrong but I think its not caused but my changes.
I tried same scenario and its happening also on the main branch.
Here is a video (sorry for low quality but its pretty long video so I needed to compress it to be able to post it in GH :) )

Untitled.mp4

It looks like its not happening when you have app opened for the first time but on next tries it redirect you to Not found page.
What would you like to do , create a seperate issue for that or you want me to fix it here?

mollfpr · 2023-08-30T15:34:50Z

Thanks for the check, @kubabutkiewicz. Yeah, it seems like it's already in main. Let's fix that on a separate issue.

mollfpr

LGTM and tests well 👍

melvin-bot · 2023-08-30T15:40:50Z

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

…ix/deeplinks-when-app-in-background-v2

kubabutkiewicz · 2023-09-08T15:38:46Z

@hayata-suenaga Hi will you be able to review it ?

hayata-suenaga · 2023-09-11T02:15:35Z

omg I completely missed this. Let me review right now

hayata-suenaga

🚀

kubabutkiewicz · 2023-09-12T08:03:31Z

Hi @hayata-suenaga , this pr is not merged due to merge freeze ?

hayata-suenaga · 2023-09-12T10:39:47Z

forgot to merge 😓

OSBotify · 2023-09-12T10:44:56Z

✋ 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-09-13T09:14:20Z

🚀 Deployed to staging by https://github.com/hayata-suenaga in version: 1.3.69-0 🚀

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

OSBotify · 2023-09-14T10:28:34Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.3.69-2 🚀

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

OSBotify · 2023-09-14T10:55:37Z

🚀 Deployed to staging by https://github.com/hayata-suenaga in version: 1.3.70-0 🚀

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

OSBotify · 2023-09-18T10:13:36Z

🚀 Deployed to production by https://github.com/thienlnam in version: 1.3.70-8 🚀

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

kubabutkiewicz and others added 7 commits August 28, 2023 13:12

fix: added navigation to every route after user log in when opening a…

d0e2fc3

…pp from deeplink

fix: changed navigation type

5e135c5

refactor/waiting for user to sign in

8090881

fix/function name typo

6e01b62

var name change for naming consitency

c68830f

change from set to Onyx.merge

0e75aa9

added early returns for Report navigation cases

39516df

kubabutkiewicz changed the title ~~Fix/deeplinks when app in background v2~~ Fix/deeplinks when app in background Aug 28, 2023

kubabutkiewicz marked this pull request as ready for review August 28, 2023 11:58

kubabutkiewicz requested a review from a team as a code owner August 28, 2023 11:58

melvin-bot bot requested review from mollfpr and removed request for a team August 28, 2023 11:58

lukemorawski approved these changes Aug 28, 2023

View reviewed changes

mollfpr reviewed Aug 28, 2023

View reviewed changes

mollfpr approved these changes Aug 30, 2023

View reviewed changes

melvin-bot bot requested a review from hayata-suenaga August 30, 2023 15:40

tienifr mentioned this pull request Aug 30, 2023

[HOLD for payment 2023-09-21] [HOLD] [$1000] Chat - LHN page displayed instead Legal name page when using deeplink #23745

Closed

6 tasks

Merge branch 'main' of github.com:kubabutkiewicz/expensify-app into f…

29e4440

…ix/deeplinks-when-app-in-background-v2

hayata-suenaga approved these changes Sep 11, 2023

View reviewed changes

hayata-suenaga merged commit b7a0046 into Expensify:main Sep 12, 2023

OSBotify mentioned this pull request Sep 13, 2023

Deploy Checklist: New Expensify 2023-09-13 #27313

Closed

72 tasks

OSBotify mentioned this pull request Sep 14, 2023

Deploy Checklist: New Expensify 2023-09-14 #27425

Closed

kubabutkiewicz deleted the fix/deeplinks-when-app-in-background-v2 branch September 15, 2023 07:19

bernhardoj mentioned this pull request Oct 12, 2023

[$500] Dev: Web - Console error on login with deep link #29285

Closed

6 tasks

tienifr mentioned this pull request Nov 29, 2023

[$500] iOS - Chat - LHN page displayed instead Address page if using deeplink #29060

Closed

6 tasks

Fix/deeplinks when app in background #26073

Fix/deeplinks when app in background #26073

Uh oh!

Conversation

kubabutkiewicz commented Aug 28, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot bot commented Aug 28, 2023

Uh oh!

mollfpr left a comment

Choose a reason for hiding this comment

Uh oh!

mollfpr Aug 28, 2023

Choose a reason for hiding this comment

Uh oh!

kubabutkiewicz Aug 29, 2023

Choose a reason for hiding this comment

Uh oh!

kubabutkiewicz Aug 29, 2023

Choose a reason for hiding this comment

Uh oh!

kubabutkiewicz commented Aug 29, 2023

Uh oh!

mollfpr commented Aug 29, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

mollfpr commented Aug 29, 2023

Uh oh!

kubabutkiewicz commented Aug 30, 2023

Uh oh!

mollfpr commented Aug 30, 2023

Uh oh!

mollfpr left a comment

Choose a reason for hiding this comment

Uh oh!

melvin-bot bot commented Aug 30, 2023

Uh oh!

kubabutkiewicz commented Sep 8, 2023

Uh oh!

hayata-suenaga commented Sep 11, 2023

Uh oh!

hayata-suenaga left a comment

Choose a reason for hiding this comment

Uh oh!

kubabutkiewicz commented Sep 12, 2023

Uh oh!

hayata-suenaga commented Sep 12, 2023

Uh oh!

OSBotify commented Sep 12, 2023

Uh oh!

OSBotify commented Sep 13, 2023

Uh oh!

OSBotify commented Sep 14, 2023

Uh oh!

OSBotify commented Sep 14, 2023

Uh oh!

OSBotify commented Sep 18, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

kubabutkiewicz commented Aug 28, 2023 •

edited

Loading

mollfpr commented Aug 29, 2023 •

edited

Loading