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 navigation to concierge after leaving the group #42020

Merged
merged 8 commits into from
May 16, 2024

Conversation

Nodebrute
Copy link
Contributor

@Nodebrute Nodebrute commented May 11, 2024

Details

Fixed Issues

$ #41128
PROPOSAL: #41128 (comment)

Tests

  1. Visit a few reports.
  2. Go to FAB > Start chat.
  3. Create a group chat.
  4. Click on the chat header.
  5. Click Leave.

Test steps for rooms

  1. Create a public room as an admin
  2. Copy the public room URL
  3. Paste the URL and signin as other user
  4. Leave the room

Test steps for android/small screen devices

  1. Create a public room from user A
  2. from user B, open android app on a specific report (to be last report) and then close it completely.
  3. from user B, open the room from deep link in android native.
  4. leave the room.

When a user leaves a room/group, Verify that they are navigated to their last opened report
If it's a new user who opens the link from incognito mode and then leaves the room, verify that they are directed to the concierge

  • Verify that no errors appear in the JS console

Offline tests

Same as above

QA Steps

  1. Visit a few reports.
  2. Go to FAB > Start chat.
  3. Create a group chat.
  4. Click on the chat header.
  5. Click Leave.

Test steps for rooms

  1. Create a public room as an admin
  2. Copy the public room URL
  3. Paste the URL and signin as other user
  4. Leave the room

Test steps for android/small screen devices

  1. Create a public room from user A
  2. from user B, open android app on a specific report (to be last report) and then close it completely.
  3. from user B, open the room from deep link in android native.
  4. leave the room.

When a user leaves a room/group, Verify that they are navigated to their last opened report
If it's a new user who opens the link from incognito mode and then leaves the room, verify that they are directed to the concierge

  • 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: mWeb Chrome
    • iOS: Native
    • iOS: mWeb 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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
    • 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 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(theme.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 the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design so the design team can review the changes.
  • 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.

Screenshots/Videos

Android: Native
Screen.Recording.2024-05-11.at.11.18.34.PM.mov
Android: mWeb Chrome
Screen.Recording.2024-05-11.at.11.21.15.PM.mov
iOS: Native
Screen.Recording.2024-05-11.at.8.17.10.PM.mov
iOS: mWeb Safari
Screen.Recording.2024-05-11.at.10.41.54.PM.mov
MacOS: Chrome / Safari
Screen.Recording.2024-05-11.at.7.52.10.PM.mov
MacOS: Desktop
Screen.Recording.2024-05-11.at.2.34.50.PM.mov

@Nodebrute Nodebrute requested a review from a team as a code owner May 11, 2024 18:22
@melvin-bot melvin-bot bot requested review from ahmedGaber93 and removed request for a team May 11, 2024 18:22
Copy link

melvin-bot bot commented May 11, 2024

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

@ahmedGaber93
Copy link
Contributor

ahmedGaber93 commented May 13, 2024

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: mWeb Chrome
    • iOS: Native
    • iOS: mWeb 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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
    • 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(theme.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 the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design so the design team can review the changes.
  • 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

Android: Native
a.mp4
Android: mWeb Chrome
aw.mp4
iOS: Native
i.mp4
iOS: mWeb Safari
iw.mp4
MacOS: Chrome / Safari
w.mp4
MacOS: Desktop
d.mp4

@@ -2517,10 +2517,12 @@ function navigateToMostRecentReport(currentReport: OnyxEntry<Report>) {
const isChatThread = ReportUtils.isChatThread(currentReport);
if (lastAccessedReportID) {
const lastAccessedReportRoute = ROUTES.REPORT_WITH_ID.getRoute(lastAccessedReportID ?? '');
const isFirstRoute = navigationRef?.current?.getState().index === 1;
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
const isFirstRoute = navigationRef?.current?.getState().index === 1;
const isFirstRoute = navigationRef?.current?.getState()?.index === 1;

Copy link
Contributor

Choose a reason for hiding this comment

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

I think we need to add a comment here to explain why we use === 1 not === 0

// If it is not a chat thread we should call Navigation.goBack to pop the current route first before navigating to last accessed report.
if (!isChatThread) {
// Fallback to the lastAccessedReportID route, if this is first route in the navigator
Navigation.goBack(lastAccessedReportRoute);
if (!isFirstRoute) {
Copy link
Contributor

Choose a reason for hiding this comment

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

I think we can combine this condition with the above if (!isChatThread && !isFirstRoute)

@ahmedGaber93
Copy link
Contributor

ahmedGaber93 commented May 13, 2024

Bug: Leave room opened from deeplink redirect to concierge.

  1. create a public room from web as a user A and copy its URL.
  2. from user B, open android app on a specific report (to be last report) and then close it completely.
  3. from user B, open the room from deep link in android native.
  4. leave the room.

User is redirect to concierge and if he clicks GoBack, it will redirect to last report, another clicks again on GoBack user go back to home screen.

20240513235055320.mp4

@ahmedGaber93
Copy link
Contributor

ahmedGaber93 commented May 13, 2024

@Nodebrute for testing purpose, we need to merge main into this branch as latest main now use different version of node, I do the merge locally to be able to test.

Leave groups work fine, but I faced this issue while testing leave room from deeplink. Are you able to reproduce it?

@Nodebrute
Copy link
Contributor Author

@ahmedGaber93 This bug isn't specific to Android; it can easily be reproduced on any small screen, such as a small browser window. It existed before these two PRs #39757 #40701. It's because didReportClose returns true in this case.

const didReportClose = wasReportRemoved && prevReport.statusNum === CONST.REPORT.STATUS_NUM.OPEN && report.statusNum === CONST.REPORT.STATUS_NUM.CLOSED;

@ahmedGaber93
Copy link
Contributor

ahmedGaber93 commented May 14, 2024

@Nodebrute well, are we able to fix it?

@Nodebrute
Copy link
Contributor Author

@ahmedGaber93 After some further digging, it appears that in this case, the closed report is still being passed to the ReportScreen, which triggers the navigateToConcierge function. Do we need to address this here? I haven't come up with a solution yet.

@ahmedGaber93
Copy link
Contributor

Do we need to address this here?

I will check it again after one hour as I am in break now. If it has a different root cause and different fix not related to this issue fix, we can ask jules to fix it in a separate issue.

@ahmedGaber93
Copy link
Contributor

ahmedGaber93 commented May 14, 2024

@Nodebrute I checked it, and I think we need to fix it here as it comes from the same place in ReportScreen.tsx that redirect to concierge.

I am thinking about using isFocused with didReportClose to prevent go to concierge after our fix call goBack as we call goBack before setting the optimisticData that will set didReportClose to true, but I am not sure about if this will affect on other scenarios. What do you think about that?

@Nodebrute
Copy link
Contributor Author

@ahmedGaber93 The isFocused solution isn't functioning as expected. Consequently, the room reappears in the LHN. I've logged the report to the console. Upon leaving the room, this is the state of the console.

In wide screens with no bug
Screenshot 2024-05-14 at 9 45 40 PM
In small screens with bug
Screenshot 2024-05-14 at 9 44 12 PM

In wide screens, when leaving the report, we don't pass the closed report to the ReportScreen. This is not the case on screens where this bug gets reproduced.

@ahmedGaber93
Copy link
Contributor

ahmedGaber93 commented May 14, 2024

@Nodebrute I agree with you analytics here, but I think this what is isFocused will try to fix.

In small screen we have transition between screens which end in 300ms, during this time ReportScreen.tsx will handle the optimisticData and redirect the user to concierge.

So in small screen we can see this issue, and this what I think it happened in small screen:

  1. we call goBack.
  2. transition will start, but ReportScreen.tsx is not unmounted yet as transition is still not ended.
  3. after setting the optimisticData, and the ReportScreen.tsx is not unmounted yet, ReportScreen.tsx will handle the optimisticData and the didReportClose will be true, then didReportClose with true value will redirect the user to concierge.
  4. transition is completed now and navigation completely goBack to last report.

In wide screen:

  1. we call goBack.
  2. ReportScreen.tsx will be unmounted as there is no transition between screens.
  3. after setting the optimisticData, ReportScreen.tsx is already unmounted and not fire any redirectToConcierge

The isFocused here should fix the issue as it will be false during the transition, so not redirectToConcierge will call during the transition.

Do you agree with that? Or I missed something.

@Nodebrute
Copy link
Contributor Author

@ahmedGaber93 I have made the following changes

 (didReportClose && isFocused)

You can see that after leaving the room it reappears in LHN

Screen.Recording.2024-05-15.at.1.58.38.PM.mov

Am I adding it incorrectly?

@ahmedGaber93
Copy link
Contributor

ahmedGaber93 commented May 15, 2024

@Nodebrute, what is the result without isFocused on a small and wide screen? and are you seeing relations between this and LHN can lead to this behavior?

@Nodebrute
Copy link
Contributor Author

Nodebrute commented May 15, 2024

User is redirect to concierge and if he clicks GoBack, it will redirect to last report, another clicks again on GoBack user go back to home screen.

Without isFocused we have this result on small screen and on Wide screens everything is working fine.

@ahmedGaber93
Copy link
Contributor

@Nodebrute well!, what do you think we should do to fix leaving from deeplink issue?

@Nodebrute
Copy link
Contributor Author

@ahmedGaber93 I'm working on it. I'll update you in a few minutes.

@Nodebrute
Copy link
Contributor Author

Nodebrute commented May 15, 2024

@ahmedGaber93 Hey, thanks for your patience. The only solution that's working here is an early return from this useEffect before navigating to the concierge.

if (
// non-optimistic case
(!prevUserLeavingStatus && !!userLeavingStatus) ||
didReportClose ||
isRemovalExpectedForReportType ||
isClosedTopLevelPolicyRoom
) {
Navigation.dismissModal();
if (Navigation.getTopmostReportId() === prevOnyxReportID) {
Navigation.setShouldPopAllStateOnUP();
Navigation.goBack(undefined, false, true);
}
if (prevReport.parentReportID) {
// Prevent navigation to the IOU/Expense Report if it is pending deletion.
const parentReport = ReportUtils.getReport(prevReport.parentReportID);
if (ReportUtils.isMoneyRequestReportPendingDeletion(parentReport)) {
return;
}
Navigation.navigate(ROUTES.REPORT_WITH_ID.getRoute(prevReport.parentReportID));
return;
}
Report.navigateToConciergeChat();
return;
}

I have added the following code block and it's working fine. I think we can also use !isFocused here too instead of isOptimisticDelete. I haven't tested all cases yet.

   if(didReportClose && isOptimisticDelete){
                return
            }

Comment on lines 543 to 545
if (!isFocused) {
return;
}
Copy link
Contributor

Choose a reason for hiding this comment

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

I think the return early should be in the first line in the block of code, there is no need for any navigation call if navigation is not focused. I think this is more clean. What do you think?

@ahmedGaber93
Copy link
Contributor

Thanks @Nodebrute 👍, I am reviewing now. Just please update "QA Steps" to include all cases available.

Copy link
Contributor

@ahmedGaber93 ahmedGaber93 left a comment

Choose a reason for hiding this comment

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

LGTM!

@@ -526,6 +525,10 @@ function ReportScreen({
isRemovalExpectedForReportType ||
isClosedTopLevelPolicyRoom
) {
// If the report isn't focused, navigation to Concierge Chat should be avoided.
Copy link
Contributor

Choose a reason for hiding this comment

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

Can you please edit this slightly to explain WHY we shouldn't navigate depending on the focus state

Copy link
Contributor

Choose a reason for hiding this comment

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

We need here to prevent ReportScreen.tsx from handling "leaving room optimisticData" during the transition time to prevent undesired redirect to concierge when user leaves a room from the same device.

I think we can say it like this:

// We shouldn't redirect to Concierge Chat when report screen is not focused, like during the transition time,
// As this can cause undesired redirection to Concierge Chat when user leaves a room from the same device.

Copy link
Contributor

@Julesssss Julesssss left a comment

Choose a reason for hiding this comment

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

Changes look good. It would be great to add a few more details to the comments though.

@Julesssss Julesssss merged commit 5bfa295 into Expensify:main May 16, 2024
18 checks passed
@OSBotify
Copy link
Contributor

✋ 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
Copy link
Contributor

🚀 Deployed to staging by https://github.com/Julesssss in version: 1.4.75-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/puneetlath in version: 1.4.75-1 🚀

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

@Nodebrute Nodebrute deleted the navigation branch September 16, 2024 00:43
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.

4 participants