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 LHN shows Not found when navigated from global create menu or report parent navigation link #43086

Conversation

bernhardoj
Copy link
Contributor

Details

Navigating from global create (FAB) or from report parent navigation link while in search page shows not found in LHN.

Fixed Issues

$ #42995
PROPOSAL: #42995 (comment)

Tests

Same as QA Steps

  • Verify that no errors appear in the JS console

Offline tests

Same as QA Steps

QA Steps

A.

  1. Open search page
  2. Click on the global create menu
  3. Submit an expense
  4. (small screen) Go back
  5. Verify the LHN shows the chat list

B.

  1. Open search page
  2. Click on a result
  3. Click on the header "From" link
  4. (small screen) Go back
  5. Verify the LHN shows the chat list
  • 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-06-05.at.10.19.13.mov
Android: mWeb Chrome
Screen.Recording.2024-06-05.at.10.09.42.mov
iOS: Native
Screen.Recording.2024-06-05.at.10.18.07.mov
iOS: mWeb Safari
Screen.Recording.2024-06-05.at.10.04.13.mov
MacOS: Chrome / Safari
Screen.Recording.2024-06-05.at.09.50.53.mov
Screen.Recording.2024-06-05.at.09.51.52.mov
MacOS: Desktop
Screen.Recording.2024-06-05.at.10.00.39.1.mov

@bernhardoj bernhardoj requested a review from a team as a code owner June 5, 2024 02:24
@melvin-bot melvin-bot bot removed the request for review from a team June 5, 2024 02:24
Copy link

melvin-bot bot commented Jun 5, 2024

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

@melvin-bot melvin-bot bot requested a review from c3024 June 5, 2024 02:24
@c3024
Copy link
Contributor

c3024 commented Jun 5, 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
43086-android.mp4
Android: mWeb Chrome
43086-androidmWeb.mp4
iOS: Native
43086-iOS.mp4
iOS: mWeb Safari
43086-iOSmWeb.mp4
MacOS: Chrome / Safari
43086-webChrome.mp4
MacOS: Desktop
43086-desktop.mp4

@bernhardoj
Copy link
Contributor Author

I notice another small issue. After performing the test step, you can notice the chat icon in the bottom tab isn't highlighted.

image

It's because if the topmost central pane is the search page, we return the search page as the current tab name.

const currentTabName = useNavigationState<RootStackParamList, string | undefined>((state) => {
const topmostCentralPaneRoute = getTopmostCentralPaneRoute(state);
if (topmostCentralPaneRoute && topmostCentralPaneRoute.name === SCREENS.SEARCH.CENTRAL_PANE) {
return SCREENS.SEARCH.CENTRAL_PANE;
}
const topmostBottomTabRoute = getTopmostBottomTabRoute(state);
return topmostBottomTabRoute?.name ?? SCREENS.HOME;

I haven't checked further the reason behind it, but I think the current tab name should only depend on the topmost bottom tab.

@bernhardoj
Copy link
Contributor Author

Also, for some reason, when I testing on other platforms other than web, the search type returned from the BE is transactions,

const type = SearchUtils.getSearchType(searchResults?.search);

function getSearchType(search: OnyxTypes.SearchResults['search']): SearchDataTypes | undefined {
if (!isSearchDataType(search.type)) {
return undefined;
}

which doesn't exist on the search data type CONST, so the type is undefined and the list is empty/blank.

App/src/CONST.ts

Lines 4802 to 4805 in 3c04b02

SEARCH_DATA_TYPES: {
TRANSACTION: 'transaction',
REPORT: 'report',
},

I manually add transactions to the CONST to be able to test this.

Copy link
Contributor

@c3024 c3024 left a comment

Choose a reason for hiding this comment

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

LGTM

@melvin-bot melvin-bot bot requested a review from luacmartins June 5, 2024 05:45
@trjExpensify
Copy link
Contributor

I notice another small issue. After performing the test step, you can notice the chat icon in the bottom tab isn't highlighted.

image It's because if the topmost central pane is the search page, we return the search page as the current tab name.

const currentTabName = useNavigationState<RootStackParamList, string | undefined>((state) => {
const topmostCentralPaneRoute = getTopmostCentralPaneRoute(state);
if (topmostCentralPaneRoute && topmostCentralPaneRoute.name === SCREENS.SEARCH.CENTRAL_PANE) {
return SCREENS.SEARCH.CENTRAL_PANE;
}
const topmostBottomTabRoute = getTopmostBottomTabRoute(state);
return topmostBottomTabRoute?.name ?? SCREENS.HOME;

I haven't checked further the reason behind it, but I think the current tab name should only depend on the topmost bottom tab.

@c3024 did you notice this as well?

@trjExpensify
Copy link
Contributor

Also, for some reason, when I testing on other platforms other than web, the search type returned from the BE is transactions,

const type = SearchUtils.getSearchType(searchResults?.search);

function getSearchType(search: OnyxTypes.SearchResults['search']): SearchDataTypes | undefined {
if (!isSearchDataType(search.type)) {
return undefined;
}

which doesn't exist on the search data type CONST, so the type is undefined and the list is empty/blank.

App/src/CONST.ts

Lines 4802 to 4805 in 3c04b02

SEARCH_DATA_TYPES: {
TRANSACTION: 'transaction',
REPORT: 'report',
},

I manually add transactions to the CONST to be able to test this.

This transaction vs transactions issue seems related to what we fixed the other day in an authPR, but had to revert when we rolled a deploy back. Carlos has a new authPR up here (you won't be able to access that link) to revert the revert to get it redeployed.

@c3024
Copy link
Contributor

c3024 commented Jun 5, 2024

I don't see it on MacOS Chrome.

chatIconFilled.mp4

@bernhardoj
Copy link
Contributor Author

@c3024 it's only on the small screen

@luacmartins
Copy link
Contributor

I notice another small issue. After performing the test step, you can notice the chat icon in the bottom tab isn't highlighted.

I do see this issue on small screens. I think it's small enough that we could tackle as a follow up. @bernhardoj would you be able to investigate that and work on a fix please?

Also, for some reason, when I testing on other platforms other than web, the search type returned from the BE is transactions

Yea, this is expected for now. Should be fixed later today

@luacmartins luacmartins merged commit 8dbec8d into Expensify:main Jun 5, 2024
16 checks passed
@OSBotify
Copy link
Contributor

OSBotify commented Jun 5, 2024

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

@Julesssss
Copy link
Contributor

Julesssss commented Jun 6, 2024

Hey, I'm struggling to locate a regression where opening users comment on a new MoneyReport, then 'Reply in Thread' and try to tap the blue Thread link causes a 'Report not found' error.

This is one of a few PRs that seem either a cause or just related. If you have any thoughts or suggestions, please let me know.

@luacmartins
Copy link
Contributor

I confirmed above that reverting this PR doesn't solve the issue.

@Julesssss
Copy link
Contributor

Thanks for testing

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/luacmartins in version: 1.4.81-11 🚀

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


// If we navigate to SCREENS.SEARCH.CENTRAL_PANE, it's necessary to pass the current policyID, but we have to remember that this param is called policyIDs on this page
if (action.payload.params?.screen === SCREENS.SEARCH.CENTRAL_PANE && action.payload?.params?.params && policyID) {
action.payload.params.params.policyIDs = policyID;
}

// If the type is UP, we deeplinked into one of the RHP flows and we want to replace the current screen with the previous one in the flow
// and at the same time we want the back button to go to the page we were before the deeplink
} else if (type === CONST.NAVIGATION.TYPE.UP) {
Copy link
Contributor

Choose a reason for hiding this comment

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

Came from this issue
We have specific case when navigation will replace the last route with the target report which is the expense report and the stack navigator becomes Bottom tab bar --> Chat report --> Expense report --> Expense report.
As result App returns to the same expense report when tapping back button

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.

7 participants