-
Notifications
You must be signed in to change notification settings - Fork 3k
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 other chat is shown briefly when navigating to concierge page #36216
Fix other chat is shown briefly when navigating to concierge page #36216
Conversation
@sobitneupane 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] |
Report.navigateToConciergeChat(); | ||
if (isUnmounted.current) { | ||
return; | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We return early here if the component is unmounted to prevent the user from being navigated to the concierge chat even after closing the concierge page
// In order to avoid creating concierge repeatedly, | ||
// we need to ensure that the server data has been successfully pulled | ||
Welcome.serverDataIsReadyPromise().then(() => { | ||
// If we don't have a chat with Concierge then create it | ||
navigateToAndOpenReport([CONST.EMAIL.CONCIERGE], shouldDismissModal); | ||
if (!checkIfCurrentPageActive()) { | ||
return; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same as above (https://github.com/Expensify/App/pull/36216/files#r1484132324)
1161480
to
b965cdd
Compare
if (route === ROUTES.CONCIERGE) { | ||
navigateToConciergeChat(true); | ||
return; | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This prevents us to deep-link to ConciergePage when logged out.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is there any issue caused by this?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, the issue is in my previous comment.
To reproduce it:
- Sign out
- Deep link to /concierge
- Sign in
- The LHN is shown instead of ConciergePage because ConciergePage is never added to the nav stack. A concierge chat will be shown eventually because we call
navigateToConciergeChat
, but ConciergePage utility page is never shown. (native)
// If conciergeChatReportID contains a concierge report ID, we navigate to the concierge chat using the stored report ID. | ||
// Otherwise, we would find the concierge chat and navigate to it. | ||
// Now, when user performs sign-out and a sign-in again, conciergeChatReportID may contain a stale value. | ||
// In order to prevent navigation to a stale value, we use ignoreConciergeReportID to forcefully find and navigate to concierge chat. | ||
if (!conciergeChatReportID || ignoreConciergeReportID) { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ignoreConciergeReportID
is only used in https://github.com/Expensify/App/pull/36216/files#r1484170212. The reason behind this param is explained by the comment itself. To properly fix it, I clear the concierge ID when the user is logged out
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Which was the PR adding this code? Won't conciergeChatReportID
get removed when singed out along with other onyx data?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It was added in #29122.
Won't conciergeChatReportID get removed when singed out along with other onyx data?
No. conciergeChatReportID
is a global(?) variable that is assigned when we receive the onyx data.
App/src/libs/actions/Report.ts
Line 170 in 6914b13
let conciergeChatReportID: string | undefined; |
App/src/libs/actions/Report.ts
Lines 1092 to 1098 in 6914b13
if (allReports && report?.reportID) { | |
allReports[report.reportID] = report; | |
if (ReportUtils.isConciergeChatReport(report)) { | |
conciergeChatReportID = report.reportID; | |
} | |
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I have a few concerns. There seem to be more changes made than what was expected in the proposal. Could you please provide more context for why these changes were necessary?
if (route === ROUTES.CONCIERGE) { | ||
navigateToConciergeChat(true); | ||
return; | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is there any issue caused by this?
let currentUserAccountID = -1; | ||
Onyx.connect({ | ||
key: ONYXKEYS.SESSION, | ||
callback: (value) => { | ||
// When signed out, val is undefined | ||
if (!value?.accountID) { | ||
conciergeChatReportID = undefined; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I am not sure if it is the correct place to make the change.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We want to clear it when signed out and I think this is the place to know whether the user is signed out or not.
// If conciergeChatReportID contains a concierge report ID, we navigate to the concierge chat using the stored report ID. | ||
// Otherwise, we would find the concierge chat and navigate to it. | ||
// Now, when user performs sign-out and a sign-in again, conciergeChatReportID may contain a stale value. | ||
// In order to prevent navigation to a stale value, we use ignoreConciergeReportID to forcefully find and navigate to concierge chat. | ||
if (!conciergeChatReportID || ignoreConciergeReportID) { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Which was the PR adding this code? Won't conciergeChatReportID
get removed when singed out along with other onyx data?
@@ -874,7 +874,7 @@ const canAccessRouteByAnonymousUser = (route: string) => { | |||
if (route.startsWith('/')) { | |||
routeRemovedReportId = routeRemovedReportId.slice(1); | |||
} | |||
const routesCanAccessByAnonymousUser = [ROUTES.SIGN_IN_MODAL, ROUTES.REPORT_WITH_ID_DETAILS.route, ROUTES.REPORT_WITH_ID_DETAILS_SHARE_CODE.route]; | |||
const routesCanAccessByAnonymousUser = [ROUTES.SIGN_IN_MODAL, ROUTES.REPORT_WITH_ID_DETAILS.route, ROUTES.REPORT_WITH_ID_DETAILS_SHARE_CODE.route, ROUTES.CONCIERGE]; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why is the change necessary?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To allow anonymous user to open ConciergePage utility page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Screenshots/Videos
Android: Native
Screen.Recording.2024-02-16.at.19.36.47.mov
Android: mWeb Chrome
iOS: Native
iOS: mWeb Safari
Screen.Recording.2024-02-16.at.16.33.11.mov
MacOS: Chrome / Safari
Untitled.mov
MacOS: Desktop
Screen.Recording.2024-02-16.at.16.24.02.mov
Thanks for the explanation @bernhardoj. In mWeb/Chrome video you uploaded, Not found page is shown briefly before opening Concierge page. NAB: The transition from Skeleton View to Concierge Chat is not smooth. I have attached a video from my test. Similar is the case in your recordings as well. Untitled_android.mov |
Yes, the not found page is always shown when refreshing the web. This has happened for a long time. Does that not happen to you? |
I am having some issues with my mWeb/Chrome. If it is not related to this PR, we are good.
Can we improve this behavior? Is the behavior similar for chats other than Concierge as well? |
I was trying to use REPLACE instead of GO BACK + NAVIGATE (see my first commit), but one flaw is that the user can open multiple concierge chats. So, if the user opens
It may look not smooth because we are trying to mimic the report screen skeleton in the concierge page utility, so the page looks like moving, but the reality is the concierge page is popped out from the stack, and the real concierge chat slides in. I think it less weird if it was a full-screen loading indicator. Screen.Recording.2024-02-20.at.18.06.49.mov |
Thanks for the update @bernhardoj. I believe I prefer the present state. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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 verified the steps for local testing are in the
- 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 notonIconClick
). - 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
- 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.
- 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 usingAvatar
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. foronClick={this.submit}
the methodthis.submit
should be bound tothis
in the constructor) - Any internal methods bound to
this
are necessary to be bound (i.e. avoidthis.submit = this.submit.bind(this);
ifthis.submit
is never passed to a component event handler likeonClick
) - 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 thatAvatar
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 form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added
Design
label 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 theTest
steps. - I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.
🚀 Deployed to staging by https://github.com/jasperhuangg in version: 1.4.44-0 🚀
|
🚀 Deployed to production by https://github.com/puneetlath in version: 1.4.44-13 🚀
|
Details
When we go to /concierge page, it opens a ConciergePage utility page and immediately pops the screen and tries to navigate to the real concierge chat. But after login, we wait until the app loading is complete, so other chat is briefly shown first when the load completes.
Fixed Issues
$ #34755
PROPOSAL: #34755 (comment)
Tests
Same as QA Steps
Offline tests
Same as QA Steps
QA Steps
PR Author Checklist
### Fixed Issues
section aboveTests
sectionOffline steps
sectionQA steps
sectiontoggleReport
and notonIconClick
)myBool && <MyComponent />
.src/languages/*
files and using the translation methodWaiting for Copy
label for a copy review on the original GH to get the correct copy.STYLE.md
) were followedAvatar
, I verified the components usingAvatar
are working as expected)StyleUtils.getBackgroundAndBorderStyle(theme.componentBG)
)Avatar
is modified, I verified thatAvatar
is working as expected in all cases)Design
label so the design team can review the changes.ScrollView
component to make it scrollable when more elements are added to the page.main
branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to theTest
steps.Screenshots/Videos
Android: Native
Screen.Recording.2024-02-09.at.16.17.29.mov
Android: mWeb Chrome
Screen.Recording.2024-02-09.at.16.01.27.mov
iOS: Native
Screen.Recording.2024-02-09.at.16.53.33.mov
iOS: mWeb Safari
Screen.Recording.2024-02-09.at.15.58.31.mov
MacOS: Chrome / Safari
Screen.Recording.2024-02-09.at.15.50.23.mov
MacOS: Desktop
Screen.Recording.2024-02-09.at.15.54.29.mov