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: regression 23735 #24619

Closed
wants to merge 9 commits into from
Closed

Conversation

tienifr
Copy link
Contributor

@tienifr tienifr commented Aug 16, 2023

Details

Fixed Issues

$ #23735
$ #24596
PROPOSAL:

Tests

  1. Go to staging.new.expensify.com
  2. Log in with account with many conversations
  3. Copy link to any chat
  4. Log out
  5. Navigate to the copied link in Step 3
  6. Log in
  7. Right after the chat is loaded, return to LHN
  8. The opened chat in Step 6 will appear in LHN while the rest of the chats is loading
  • Verify that no errors appear in the JS console

Offline tests

QA Steps

  1. Go to staging.new.expensify.com
  2. Log in with account with many conversations
  3. Copy link to any chat
  4. Log out
  5. Navigate to the copied link in Step 3
  6. Log in
  7. Right after the chat is loaded, return to LHN
  8. The opened chat in Step 6 will appear in LHN while the rest of the chats is loading
  • 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-08-16.at.17.57.58.mov
Mobile Web - Chrome
original-414BB5EF-20BB-41E6-A946-0D3A3E1785F3.mp4
Mobile Web - Safari
original-BD1DE897-397C-4749-A13C-60DD64E31C5D.mp4
Desktop
Screen.Recording.2023-08-07.at.16.38.45.mp4
iOS
Screen.Recording.2023-08-16.at.18.09.50.mov
Android
Screen.Recording.2023-08-16.at.18.21.09.mov

@tienifr
Copy link
Contributor Author

tienifr commented Aug 16, 2023

@ArekChr In this PR I want to remove useCurrentReportID because on mobile platform, we can't get the currentReportID in LHN page. After users login successfully, only one chat will be opened, when they go back to LHN, we will show the this report within skeleton. In order to archive that, we can lean on the first item in optionListItems

@tienifr tienifr marked this pull request as ready for review August 16, 2023 11:40
@tienifr tienifr requested a review from a team as a code owner August 16, 2023 11:40
@melvin-bot melvin-bot bot requested review from ArekChr and removed request for a team August 16, 2023 11:40
@melvin-bot
Copy link

melvin-bot bot commented Aug 16, 2023

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

@ArekChr
Copy link
Contributor

ArekChr commented Aug 16, 2023

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
web.mov
Mobile Web - Chrome
mweb.chrome.mov
Mobile Web - Safari
mweb.safari.mov
Desktop
desktop.mov
iOS
ios.mov
Android
android.mov

@ArekChr
Copy link
Contributor

ArekChr commented Aug 16, 2023

@tienifr I'm trying to reproduce but only successfully on ios/mWeb safari/web/mWeb chrome, I can't open the deep link on native android and desktop. What steps are to reproduce it on these platforms?

@tienifr
Copy link
Contributor Author

tienifr commented Aug 16, 2023

@ArekChr here you are:

npx uri-scheme open new-expensify://concierge --android

Copy link
Contributor

@ArekChr ArekChr left a comment

Choose a reason for hiding this comment

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

Works as expected, LGTM!

Comment on lines 133 to 142
componentDidUpdate() {
const firstLoadedReportID = this.props.optionListItems[0];
if (!this.props.isLoading || this.state.firstLoadedReportID || !firstLoadedReportID) {
return;
}

this.setState({
firstLoadedReportID,
});
}
Copy link
Contributor

Choose a reason for hiding this comment

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

There are better approaches than this. Currently, data might be changed from props and will not be updated. Also, the state is set after the first or second render. I propose to move this value to const before the render method.

const firstLoadedReportID = this.props.optionListItems[0] || ""

Copy link
Contributor Author

Choose a reason for hiding this comment

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

move this value to const before the render method.

sorry I don't really understand your mean. How can we do this because the reports will be empty at the first render right? Can you share the diff? @ArekChr

Copy link
Contributor

Choose a reason for hiding this comment

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

diff --git a/src/pages/home/sidebar/SidebarLinks.js b/src/pages/home/sidebar/SidebarLinks.js
index 9d74c63d4a..b8ae8da846 100644
--- a/src/pages/home/sidebar/SidebarLinks.js
+++ b/src/pages/home/sidebar/SidebarLinks.js
@@ -130,17 +130,6 @@ class SidebarLinks extends React.PureComponent {
         ReportActionContextMenu.hideContextMenu(false);
     }
 
-    componentDidUpdate() {
-        const firstLoadedReportID = this.props.optionListItems[0];
-        if (!this.props.isLoading || this.state.firstLoadedReportID || !firstLoadedReportID) {
-            return;
-        }
-
-        this.setState({
-            firstLoadedReportID,
-        });
-    }
-
     componentWillUnmount() {
         SidebarUtils.resetIsSidebarLoadedReadyPromise();
         if (this.unsubscribeEscapeKey) {
@@ -190,6 +179,8 @@ class SidebarLinks extends React.PureComponent {
     render() {
         const viewMode = this.props.priorityMode === CONST.PRIORITY_MODE.GSD ? CONST.OPTION_MODE.COMPACT : CONST.OPTION_MODE.DEFAULT;
 
+        const firstLoadedReportID = this.props.optionListItems[0] || '';
+
         return (
             <View style={[styles.flex1, styles.h100]}>
                 <View
@@ -243,9 +234,9 @@ class SidebarLinks extends React.PureComponent {
                 </View>
                 {this.props.isLoading ? (
                     <>
-                        {this.state.firstLoadedReportID && (
+                        {firstLoadedReportID && (
                             <OptionRowLHNData
-                                reportID={this.state.firstLoadedReportID}
+                                reportID={firstLoadedReportID}
                                 viewMode={viewMode}
                                 shouldDisableFocusOptions={this.props.isSmallScreenWidth}
                                 onSelectRow={this.showReportPage}

Copy link
Contributor

Choose a reason for hiding this comment

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

But this.props.isLoading is removed from the logic. Still determining if this is needed.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I don't think your solution will work because this.props.optionListItems[0] can be changed when the isLoading is true

Copy link
Contributor

Choose a reason for hiding this comment

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

Ok I see now, good then

@tienifr
Copy link
Contributor Author

tienifr commented Aug 18, 2023

@ArekChr as @aldo-expensify's suggestion, I also think firstLoadedReportID is not the good idea. So I want to change the PR a bit

  1. Fix the regression by using isFirstTimeReportLoading in SidebarLinksData.js
  2. use firstAccessReportID = useRef(currentReportID) to store the first accessed reportID. if it has data (user open app from deeplink), we should show it while report are loading. Otherwise, show the full skeleton page.

I've tested all cases:

  • go to /r/:reportID and login in web/mweb
  • go to http://locahost:8082 and login in web/mweb
  • go offline and online again

and all cases work well. But I still need your help to check them again. Thanks very much

@ArekChr
Copy link
Contributor

ArekChr commented Aug 18, 2023

I see, from what I see it looks like firstLoadedReportID comes from getTopmostReportId, which takes reportID from params (URL). Could you investigate that? Is that value (firstLoadedReportID) changed?

@tienifr
Copy link
Contributor Author

tienifr commented Aug 21, 2023

@ArekChr Sorry but I don't really understand your mean. I removed firstLoadedReportID because I think it was not the good idea. we can use getTopmostReportId to get the first accessed reportID (useRef(getTopmostReportId()), then use this value to show report on LHN (it's the same as useRef(currentReportID))

@ArekChr
Copy link
Contributor

ArekChr commented Aug 21, 2023

I'm okay with both, if the value is the same let's stay with firstLoadedReportID.

Maybe not useRef as this is a class component, but it can be set in the constructor as an equivalent, @aldo-expensify any thoughts about the approach used to get the first value from firstLoadedReportID?

@aldo-expensify
Copy link
Contributor

Maybe not useRef as this is a class component, but it can be set in the constructor as an equivalent, @aldo-expensify any thoughts about the approach used to get the first value from firstLoadedReportID?

From my understanding, the "equivalent" to useRef in class components would be to store it in this (instance of the component)

return;
}
setIsFirstTimeReportLoading(isLoadingReportData);
}, [isFirstTimeReportLoading, isLoadingReportData]);
Copy link
Contributor

Choose a reason for hiding this comment

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

The code is not very intuitive about:

  • Why do we initialize isFirstTimeReportLoading using SessionUtils.didUserLogInDuringSession()
  • Why do we need/use isFirstTimeReportLoading instead of isLoadingReportData

Would be good to add some comments, on why we are doing things like we are here.

I also have to get familiarized with SessionUtils.didUserLogInDuringSession() as I'm not what does this state represent and why does it matter for the LHN

@aldo-expensify
Copy link
Contributor

I'm okay with both, if the value is the same let's stay with firstLoadedReportID.

What do you mean with this? Are you saying we should revert to the implementation that was using a state?

Maybe not useRef as this is a class component, but it can be set in the constructor as an equivalent, @aldo-expensify any thoughts about the approach used to get the first value from firstLoadedReportID?

Not sure if it answers your question.... I understand that:

  • SidebarLinksData: wraps SidebarLinks and seems to be getting the data that we pass down to SidebarLinks. Considering that, it makes sense to me to put the logic of figuring out the firstAccessReportID here and pass the ID down to SidebarLinks. Then SidebarLinks doesn't need the HOC to get the currentReportID.
  • SidebarLinks: Just have to render based on what it got from the props, no responsibility on figuring out if it is the first reportID or not.

I'm fine with the implementation, but I think we should definitely add more comments so this doesn't get removed by mistakes. The code is not enough in this case to understand easily why things are implemented this way.

@tienifr
Copy link
Contributor Author

tienifr commented Aug 22, 2023

@aldo-expensify @ArekChr Thanks for your reviews. I just added some comments to explain what I did. Are they enough to understand?

@ArekChr
Copy link
Contributor

ArekChr commented Aug 22, 2023

What do you mean with this? Are you saying we should revert to the implementation that was using a state?

I mean that both firstLoadedReportID and getTopmostReportId() give us the same report ID. So, either one works for what we're trying to do. If they're the same, let's just keep using firstLoadedReportID.

@@ -66,7 +66,13 @@ const defaultProps = {
function SidebarLinksData({isFocused, allReportActions, betas, chatReports, currentReportID, insets, isLoadingReportData, isSmallScreenWidth, onLinkClick, policies, priorityMode}) {
const {translate} = useLocalize();

// SessionUtils.didUserLogInDuringSession() is true means the users have just logged in successfully, the full reports are not available util the `OpenApp` API returns data.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
// SessionUtils.didUserLogInDuringSession() is true means the users have just logged in successfully, the full reports are not available util the `OpenApp` API returns data.
// SessionUtils.didUserLogInDuringSession() Determine if this is the user's first time loading reports in the current session.
// Full reports will be unavailable until the `OpenApp` API returns data for newly logged-in users.

@tienifr
Copy link
Contributor Author

tienifr commented Aug 24, 2023

@ArekChr Can you help check again? Thanks

@aldo-expensify
Copy link
Contributor

@tienifr I think we are going to go with this PR: #25159 (comment), just letting you know so you hold on spending more time on this for now.

@tienifr tienifr closed this Aug 30, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants