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 duplicate concierge report was created #19294

Merged
merged 6 commits into from
May 24, 2023

Conversation

hellohublot
Copy link
Contributor

@hellohublot hellohublot commented May 19, 2023

Details

In order to avoid creating concierge repeatedly, we need to accurately judge the conciergeChatReportID, so we need to wait for the OpenApp interface request to succeed before making an empty judgment

Fixed Issues

$ #17884
$ #17884 (comment)

Tests

Since deep links seem to only work in online environments, looks like it has some issues with the online environment too, and this problem only exists in browser, our condition in navigateToConciergeChat is also robust enough, so we can skip screenshots for desktop and android

  1. Log out
  2. Add /concierge at the end of the browser url (If you are testing iOS native app, at this step you should enter new-expensify://concierge in mobile safari, and then open the app)
  3. Continue to log in
  4. Verify that navigating to the correct concierge report and no duplicate concierge report are created
  • Verify that no errors appear in the JS console

Offline tests

QA Steps

Same as others

  • 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
    • For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
    • Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
    • All JSX used for rendering exists in the render method
    • The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
  • If any new file was added I verified that:
    • The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
  • If a new CSS style is added I verified that:
    • A similar style doesn't already exist
    • The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG))
  • If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
  • If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
  • If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
  • If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
  • If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
  • I have checked off every checkbox in the PR author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

Existing account

_web.mov

New account

_web.mov
Mobile Web - Chrome
_mobile_chrome.mp4
Mobile Web - Safari
_mobile_safari.mp4
Desktop
iOS
_ios.mp4
Android

@hellohublot hellohublot requested a review from a team as a code owner May 19, 2023 15:23
@melvin-bot melvin-bot bot requested review from 0xmiros and mountiny and removed request for a team May 19, 2023 15:23
@melvin-bot
Copy link

melvin-bot bot commented May 19, 2023

@mountiny @0xmiroslav One of you needs to 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]

@0xmiros
Copy link
Contributor

0xmiros commented May 19, 2023

@hellohublot you can still test desktop deep link. With desktop app installed or opened, navigating https://new.expensify.com/concierge link in browser should show popup to open desktop app. And after open, deep link should work.

@hellohublot
Copy link
Contributor Author

@0xmiroslav Thank you for your suggestion, I can’t open it in the previous test, maybe I should use the safari browser, I will add screenshots of desktop tomorrow or the day after tomorrow, Thanks

@0xmiros
Copy link
Contributor

0xmiros commented May 19, 2023

@0xmiroslav Thank you for your suggestion, I can’t open it in the previous test, maybe I should use the safari browser, I will add screenshots of desktop tomorrow or the day after tomorrow, Thanks

In order to test chrome browser in dev mode, you need to comment this line to show popup:

if (!this.isMacOSWeb() || CONFIG.ENVIRONMENT === CONST.ENVIRONMENT.DEV) {
return;
}

@hellohublot
Copy link
Contributor Author

hellohublot commented May 20, 2023

@0xmiroslav Thanks for your suggestion, but I still can't open it

_desktop.mov
  • I tested both in staging environment and debug environment, it will keep spinning
  • I tested /settings and it keeps spinning as well
  • I tested /r/1, it doesn't keep spinning, but it doesn't navigate correctly to NotFound
  • I see an error in the console in the debug environment
BaseNavigationContainer.js?f126:338 The action 'NAVIGATE' with payload {"name":"Concierge","path":"/concierge","params":{}} was not handled by any navigator.

Do you have a screen named 'Concierge'?

If you're trying to navigate to a screen in a nested navigator, see https://reactnavigation.org/docs/nesting-navigators#navigating-to-a-screen-in-a-nested-navigator.

This is a development-only warning and won't be shown in production.

So I guess we can give up desktop screenshots as it still has some other issues, but I still providing iOS screenshots, I think it's enough proof that we've fixed the duplicate concierge

@mountiny
Copy link
Contributor

@hellohublot does this work in staging?

@mountiny
Copy link
Contributor

@0xmiroslav would you be able to give this one a look soon?

@hellohublot
Copy link
Contributor Author

hellohublot commented May 23, 2023

@mountiny Yes, you can see that screenshot is from staging environment

  • I tested both in staging environment and debug environment, it will keep spinning

@github-actions
Copy link
Contributor

⚠️ ⚠️ 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.

@0xmiros
Copy link
Contributor

0xmiros commented May 23, 2023

I finally found and confirmed 2 regressions:

  1. FAB menu not automatically opening
  2. full screen loading instead of skeleton views
  • navigate to /concierge directly after login (from this PR)
Screen.Recording.2023-05-23.at.3.01.21.PM.mov
  • normal login (from this PR)
53.mov
  • normal login (main)
55.mov

@hellohublot please check if you experience the same

@mountiny
Copy link
Contributor

Thanks for thorough testing, I agree that both issues are quite important blockers/ regressions. We definitely need the FAB to be opened and the skeleton loading view is better than full loading spinner.

@hellohublot could we maybe move the promise more down the stack to where we decide what report to fetch to ensure we only hold the concierge chat fetch call? I am not sure if that is possible to do

@hellohublot

This comment was marked as outdated.

@mountiny
Copy link
Contributor

@hellohublot How is it looking? Would be great to get this out soon as this is causing errors in our API layer as users are trying to access stale chats.

@hellohublot
Copy link
Contributor Author

hellohublot commented May 23, 2023

Here is a further investigation, the full screen loading comes from ConciergePage.FullScreenLoadingIndicator, due to the delay caused by ConciergePage.Report.navigateToConciergeChat, it did not navigate to report pages as soon as possible to hide the full screen loading, which also caused when the FloatingActionButtonAndPopover.showCreateMenu is called, actually FloatingActionButton has not been rendered to the screen

function navigateToConciergeChat() {
    if (!conciergeChatReportID) {
        // In order not to delay the report life cycle, we first navigate to the unknow report
        if (Navigation.getReportIDFromRoute().length <= 0) {
            Navigation.navigate(ROUTES.REPORT);
        }
        // In order to avoid creating concierge repeatedly,
        // we need to ensure that the server data has been successfully pulled
        Welcome.serverDataIsReadyPromise().then(() => {
            navigateToAndOpenReport([CONST.EMAIL.CONCIERGE]);
        })
    } else {
        Navigation.navigate(ROUTES.getReportRoute(conciergeChatReportID));
    }
}

I'm still searching for the best solution, you guys can give me some inspiration too, Thanks

@hellohublot
Copy link
Contributor Author

@mountiny Yes, this solution can solve the two regressions

_output.mp4

@0xmiroslav Thank you. It's done. Could you please help me review it again?

@0xmiros
Copy link
Contributor

0xmiros commented May 23, 2023

@mountiny as seen in video, the url changes multiple times. Is that fine?

  • /concierge
  • /r
  • /r/6494117186628521
54.mov

@hellohublot can you investigate why navigateToConciergeChat() is called 2 times unnecessarily?

@hellohublot
Copy link
Contributor Author

hellohublot commented May 23, 2023

@0xmiroslav Thanks for your feedback

The staging environment will also navigate twice because we don't know the conciergeReportId yet but want to show the ReportScreen, so I think it's unavoidable

_web.mov

The first call chain: react-navigation-url-change -> linkingConfig -> ConciergePage -> Report.navigateToConciergeChat

The second call chain: Expensify -> Linking.getInitialURL -> Report.openReportFromDeepLink -> Report.navigateToConciergeChat

@0xmiros
Copy link
Contributor

0xmiros commented May 23, 2023

The staging environment will also navigate twice because we don't know the conciergeReportId yet but want to show the ReportScreen, so I think it's unavoidable

ok, as it happens on main, can be out of scope

@0xmiros
Copy link
Contributor

0xmiros commented May 23, 2023

@hellohublot please fix conflict

@hellohublot
Copy link
Contributor Author

@0xmiroslav Thanks, done

@0xmiros
Copy link
Contributor

0xmiros commented May 24, 2023

One thing I found while testing but hopefully out of scope since it's already happening on main

Reproducible step:

desktop-bug-branch.mov
Screenshot 2023-05-24 at 11 53 57 AM

Copy link
Contributor

@0xmiros 0xmiros left a comment

Choose a reason for hiding this comment

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

@hellohublot let's fix these minor and all good except 2 known issues I mentioned above

src/libs/actions/Report.js Show resolved Hide resolved
if (!conciergeChatReportID) {
navigateToAndOpenReport([CONST.EMAIL.CONCIERGE]);
return;
// In order not to delay the report life cycle, we first navigate to the unknow report
Copy link
Contributor

Choose a reason for hiding this comment

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

unkow -> unknown

navigateToAndOpenReport([CONST.EMAIL.CONCIERGE]);
return;
// In order not to delay the report life cycle, we first navigate to the unknow report
if (Navigation.getReportIDFromRoute().length <= 0) {
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
if (Navigation.getReportIDFromRoute().length <= 0) {
if (_.isEmpty(Navigation.getReportIDFromRoute())) {

@mountiny
Copy link
Contributor

@0xmiroslav Thanks for the thorough testing, can you report those bugs in bugs channel please.

@hellohublot lets fix the comments from @0xmiroslav and I will ship this!

@0xmiros
Copy link
Contributor

0xmiros commented May 24, 2023

In Web, I added videos of various cases

Web
  • /concierge with new account
54-new-concierge.mov
  • no deep link with new account
56-new-normal.mov
  • /concierge with existing account
concierge.mov
  • no deep link with existing account
normal.mov
Mobile Web - Chrome
mchrome.mov
Mobile Web - Safari
msafari.mov
Desktop
desktop.mov

Copy link
Contributor

@mountiny mountiny left a comment

Choose a reason for hiding this comment

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

Thanks everyone!

@mountiny
Copy link
Contributor

mountiny commented May 24, 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 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

C+ already added screenshots

Web
Mobile Web - Chrome
Mobile Web - Safari
Desktop
iOS
Android

@0xmiros
Copy link
Contributor

0xmiros commented May 24, 2023

Oh I thought @mountiny already filled checklist so I added only screenshots.

@mountiny
Copy link
Contributor

np

@mountiny mountiny merged commit b10f19d into Expensify:main May 24, 2023
OSBotify pushed a commit that referenced this pull request May 24, 2023
…eated

Fix duplicate concierge report was created

(cherry picked from commit b10f19d)
madmax330 added a commit that referenced this pull request May 24, 2023
@OSBotify
Copy link
Contributor

🚀 Cherry-picked to staging by https://github.com/mountiny in version: 1.3.17-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.

@mvtglobally
Copy link

We are getting Endless spinner on Desktop and blocked from validation. rest platforms are pass.

19294.Desktop.mp4

@chiragsalian
Copy link
Contributor

I consider the above report by maria as a non blocker since the problem exists on production as well so we're still proceeding with deploy.

Is the reported issue by maria something you can investigate @hellohublot?

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/chiragsalian in version: 1.3.17-5 🚀

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

@0xmiros
Copy link
Contributor

0xmiros commented May 25, 2023

I consider the above report by maria as a non blocker since the problem exists on production as well so we're still proceeding with deploy.

Is the reported issue by maria something you can investigate @hellohublot?

@chiragsalian I already reported here - #19294 (comment)
Also in slack - https://expensify.slack.com/archives/C049HHMV9SM/p1684924597264749

@OSBotify
Copy link
Contributor

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

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

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

Welcome.serverDataIsReadyPromise().then(() => {
// If we don't have a chat with Concierge then create it
navigateToAndOpenReport([CONST.EMAIL.CONCIERGE]);
});
Copy link
Contributor

Choose a reason for hiding this comment

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

In order to avoid creating concierge repeatedly,

What does this mean?

we need to ensure that the server data has been successfully pulled

Server data? What server data?

Copy link
Contributor

Choose a reason for hiding this comment

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

When the concierge deeplink has been opened without the report data locally after signing in as in the test steps, this code did not wait to fetch the actual reportID of the chat between user and concierge and instead it created a new optimistic chat. This however is "stale" chat then as that particular user already has existing chat with concierge with different reportID.

if (!conciergeChatReportID) {
navigateToAndOpenReport([CONST.EMAIL.CONCIERGE]);
return;
// In order not to delay the report life cycle, we first navigate to the unknown report
Copy link
Contributor

Choose a reason for hiding this comment

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

This comment also makes no sense to me.

Comment on lines +1131 to +1133
if (_.isEmpty(Navigation.getReportIDFromRoute())) {
Navigation.navigate(ROUTES.REPORT);
}
Copy link
Contributor

Choose a reason for hiding this comment

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

This code introduced a regression in #26314. Specifically, when deep linking to the concierge from a logged-out user, after login, the "not found" page is displayed while the concierge report is being retrieved from the server.

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.

8 participants