Always call OpenReport when deeplinking within the app #15897

jasperhuangg · 2023-03-13T16:38:25Z

Details

This solves a problem where we don't call OpenReport when deeplinking from within the App.

componentDidMount never fires when you're deeplinking from within the app. Only componentDidUpdate fires, but that early returns for public reports. We could call OpenReport in componentShouldUpdate, but that's an anti-pattern that could cause some unintended consequences.

Therefore, this updates the AnchorRenderer to call OpenReport before navigating to a report within the app.

Fixed Issues

$ N/A

Tests/QA

Click on a link to a public report you haven't joined yet from within the app.
Verify you can access the room.

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

Screenshots/Videos

Web

web.mov

Mobile Web - Chrome

mweb-chrome.mov

Mobile Web - Safari

mweb-safari.mp4

Desktop

desktop.mov

iOS

ios.mp4

Android

android.mov

jasperhuangg · 2023-03-13T17:11:12Z

src/pages/home/ReportScreen.js

@@ -221,7 +221,7 @@ class ReportScreen extends React.Component {
                    )}
                >
                    <FullPageNotFoundView
-                        shouldShow={!this.props.report.reportID}
+                        shouldShow={!this.props.report.reportID && !this.props.report.isLoadingReportActions}


This prevents the No Access screen from showing while the OpenApp call is loading

jasperhuangg · 2023-03-13T17:11:24Z

cc @tgolen @chiragsalian

github-actions · 2023-03-13T17:43:35Z

⚠️ ⚠️ Heads up! This pull request has the CP Staging label ⚠️ ⚠️
If you applied the CP Staging label before the PR was merged, the PR will be be immediately deployed to staging even if the open StagingDeployCash deploy checklist is locked.
However if you applied the CP Staging after the PR was merged it's possible it won't be CP'ed automatically. If you need it to be CP'ed to staging, tag a member of @Expensify/mobile-deployers to CP it manually, otherwise you can wait for it to go out with the next deploy.

MelvinBot · 2023-03-13T17:43:52Z

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

mountiny · 2023-03-13T17:52:01Z

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 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 correct English and 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 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

due to urgency i havent taken screenshots, there are videos fro Jasper in the PR body

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

mountiny

Look

src/components/HTMLEngineProvider/HTMLRenderers/AnchorRenderer.js

Julesssss

👍

mountiny

would be nice to leave some comment for why but looking good

mountiny · 2023-03-13T18:24:52Z

src/components/HTMLEngineProvider/HTMLRenderers/AnchorRenderer.js

@@ -47,6 +48,11 @@ const AnchorRenderer = (props) => {
        // If we are handling a New Expensify link then we will assume this should be opened by the app internally. This ensures that the links are opened internally via react-navigation
        // instead of in a new tab or with a page refresh (which is the default behavior of an anchor tag)
        if (internalNewExpensifyPath) {
+            if (attrPath.indexOf('r/') === 0) {


NAB: should we check for this instead?

Suggested change

if (attrPath.indexOf('r/') === 0) {

if (attrPath.startsWith('r/') === 0) {

…dDeepLinkingWithinApp Always call OpenReport when deeplinking within the app (cherry picked from commit 0553fee)

…-15897 🍒 Cherry pick PR #15897 to staging 🍒

OSBotify · 2023-03-13T19:56:50Z

🚀 Cherry-picked to staging by https://github.com/mountiny in version: 1.2.83-2 🚀

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

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

OSBotify · 2023-03-14T02:59:43Z

🚀 Deployed to production by https://github.com/roryabraham in version: 1.2.83-3 🚀

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

OSBotify · 2023-06-15T01:35:31Z

🚀 Cherry-picked to staging by https://github.com/AndrewGable in version: 1.3.28-2 🚀

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 · 2023-06-16T18:53:16Z

🚀 Deployed to production by https://github.com/AndrewGable in version: 1.3.28-5 🚀

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

Always call OpenReport when deeplinking within the app

2a04de5

jasperhuangg self-assigned this Mar 13, 2023

call openReport when navigating to deeplinks within the App

5119171

jasperhuangg commented Mar 13, 2023

View reviewed changes

style

953504c

jasperhuangg marked this pull request as ready for review March 13, 2023 17:43

jasperhuangg requested a review from a team as a code owner March 13, 2023 17:43

jasperhuangg added the CP Staging label Mar 13, 2023

melvin-bot bot requested review from AndrewGable and removed request for a team March 13, 2023 17:43

jasperhuangg requested a review from mountiny March 13, 2023 17:47

mountiny requested changes Mar 13, 2023

View reviewed changes

src/components/HTMLEngineProvider/HTMLRenderers/AnchorRenderer.js Outdated Show resolved Hide resolved

Julesssss reviewed Mar 13, 2023

View reviewed changes

jasperhuangg added 2 commits March 13, 2023 14:03

handle other url formats

e24fce5

handle other url formats

63aa701

mountiny requested review from mountiny and Julesssss March 13, 2023 18:06

mountiny approved these changes Mar 13, 2023

View reviewed changes

Julesssss mentioned this pull request Mar 13, 2023

Deploy Checklist: New Expensify 2023-03-13 #15889

Closed

16 tasks

mountiny approved these changes Mar 13, 2023

View reviewed changes

mountiny merged commit 0553fee into main Mar 13, 2023

mountiny deleted the jasper-fixOpenReportNotCalledDeepLinkingWithinApp branch March 13, 2023 18:25

OSBotify pushed a commit that referenced this pull request Mar 13, 2023

Merge pull request #15897 from Expensify/jasper-fixOpenReportNotCalle…

6580823

…dDeepLinkingWithinApp Always call OpenReport when deeplinking within the app (cherry picked from commit 0553fee)

OSBotify mentioned this pull request Mar 13, 2023

🍒 Cherry pick PR #15897 to staging 🍒 #15902

Merged

OSBotify added a commit that referenced this pull request Mar 13, 2023

Merge pull request #15902 from Expensify/OSBotify-cherry-pick-staging…

f64c0c6

…-15897 🍒 Cherry pick PR #15897 to staging 🍒

jasperhuangg mentioned this pull request Mar 13, 2023

[NO QA] Fix leftover review comments on App/pull/15897 #15904

Merged

53 tasks

aimane-chnaif mentioned this pull request Mar 13, 2023

New skeleton loader for LHN #14456

Merged

54 tasks

OSBotify mentioned this pull request May 2, 2023

Deploy Checklist: New Expensify 2023-05-02 #18315

Closed

OSBotify mentioned this pull request Jun 15, 2023

Deploy Checklist: New Expensify 2023-06-14 #20782

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Always call OpenReport when deeplinking within the app #15897

Always call OpenReport when deeplinking within the app #15897

jasperhuangg commented Mar 13, 2023 •

edited

Loading

jasperhuangg Mar 13, 2023

jasperhuangg commented Mar 13, 2023

github-actions bot commented Mar 13, 2023

MelvinBot commented Mar 13, 2023

mountiny commented Mar 13, 2023 •

edited

Loading

mountiny left a comment

Julesssss left a comment

mountiny left a comment

mountiny Mar 13, 2023

OSBotify commented Mar 13, 2023

OSBotify commented Mar 14, 2023

OSBotify commented Jun 15, 2023

OSBotify commented Jun 16, 2023

	if (attrPath.indexOf('r/') === 0) {
	if (attrPath.startsWith('r/') === 0) {

Always call OpenReport when deeplinking within the app #15897

Always call OpenReport when deeplinking within the app #15897

Conversation

jasperhuangg commented Mar 13, 2023 • edited Loading

Details

Fixed Issues

Tests/QA

PR Author Checklist

Screenshots/Videos

jasperhuangg Mar 13, 2023

Choose a reason for hiding this comment

jasperhuangg commented Mar 13, 2023

github-actions bot commented Mar 13, 2023

MelvinBot commented Mar 13, 2023

mountiny commented Mar 13, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

mountiny left a comment

Choose a reason for hiding this comment

Julesssss left a comment

Choose a reason for hiding this comment

mountiny left a comment

Choose a reason for hiding this comment

mountiny Mar 13, 2023

Choose a reason for hiding this comment

OSBotify commented Mar 13, 2023

OSBotify commented Mar 14, 2023

OSBotify commented Jun 15, 2023

OSBotify commented Jun 16, 2023

jasperhuangg commented Mar 13, 2023 •

edited

Loading

mountiny commented Mar 13, 2023 •

edited

Loading