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

Filter out search central pane in small screen #43628

Conversation

bernhardoj
Copy link
Contributor

Details

On a small screen, we want to hide the search central pane screen. The current code only hides it if it's the last route in the stack, but this PR improves it so it's always filtered out if exist on the stack.

Fixed Issues

$ #43478
PROPOSAL: #43478 (comment)

Tests

Same as QA Steps

  • Verify that no errors appear in the JS console

Offline tests

Same as QA Steps

QA Steps

  1. Open search page
  2. Open any report
  3. Verify the transaction screen opens
  4. (iOS/mWeb iOS) Swipe right and don't release the finger (Android/Android mWeb) Press back button
  5. Verify you can see the search page list under the transaction screen
  • 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-13.at.11.36.08.mov
Android: mWeb Chrome
Screen.Recording.2024-06-13.at.11.57.24.mov
iOS: Native
Screen.Recording.2024-06-13.at.11.26.00.mov
iOS: mWeb Safari
Screen.Recording.2024-06-13.at.11.28.24.mov
MacOS: Chrome / Safari Screenshot 2024-06-13 at 11 25 30
MacOS: Desktop Screenshot 2024-06-13 at 11 26 47

@bernhardoj bernhardoj requested a review from a team as a code owner June 13, 2024 04:06
@melvin-bot melvin-bot bot requested review from eh2077 and removed request for a team June 13, 2024 04:06
Copy link

melvin-bot bot commented Jun 13, 2024

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

},
searchRoute: lastRoute,
searchRoute: routes[searchCentralPaneIndex],
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@luacmartins The reason I don't use filter is the searchRoute here expects that we pass the found search central pane route, so I need the found index of the route. The searchRoute is being used here

{searchRoute && <View style={styles.dNone}>{descriptors[searchRoute.key].render()}</View>}

but I can't see any difference though with or without searchRoute. Maybe we can ask someone from SWM to check this too. If we can safely remove it, then we can use filter.

@eh2077
Copy link
Contributor

eh2077 commented Jun 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
android.mov
Android: mWeb Chrome
mobile-chrome.mov
iOS: Native
ios.mov
iOS: mWeb Safari
mobile-safari.mov
MacOS: Chrome / Safari
web.mov
MacOS: Desktop
desktop.mov

@luacmartins luacmartins self-requested a review June 13, 2024 14:56
Copy link
Contributor

@luacmartins luacmartins left a comment

Choose a reason for hiding this comment

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

LGTM @adamgrzybowski @Kicu @WojtekBoman could one of you review these changes too please?

Copy link
Contributor

@eh2077 eh2077 left a comment

Choose a reason for hiding this comment

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

Looks good and tested well

@melvin-bot melvin-bot bot requested a review from luacmartins June 13, 2024 16:44
luacmartins
luacmartins previously approved these changes Jun 13, 2024
@luacmartins
Copy link
Contributor

Waiting on @WojtekBoman @Kicu or @adamgrzybowski's review

@adamgrzybowski
Copy link
Contributor

That's correct root cause, and we need something like that. But I am not sure about one thing. Does this solution assumes that the central pane search page occurs only once in the state? What if we have something like:

report, search, search, report, search?

I guess we may need to use filter with combination of findLast for index.

And answering to your question about why we need to render this page at all.

In proposal you correctly noticed that both pages have the same url:

When we go to the search page, we add both search bottom tab and search central pane. (both have the same url)

But this is not something that react navigation supports. To achieve this, we use url of the search central page for both bottom tab and central page.

To be specific we call render method on the descriptor of this page which sets the url. But we hide it with the display none.

If you think this is weird... well... 😄 I agree.

cc: @bernhardoj

@bernhardoj
Copy link
Contributor Author

To be specific we call render method on the descriptor of this page which sets the url. But we hide it with the display none.

I see. I can see the difference now. Thanks for the explanation!

Updated the code to reflect the suggestion above.

Does this solution assumes that the central pane search page occurs only once in the state?

Yes 😅

@adamgrzybowski
Copy link
Contributor

@bernhardoj @luacmartins LGTM! Great work!

Copy link
Contributor

@luacmartins luacmartins left a comment

Choose a reason for hiding this comment

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

LGTM! Nice work!

@luacmartins luacmartins merged commit ee20f2a into Expensify:main Jun 17, 2024
15 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/luacmartins in version: 1.4.85-0 🚀

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

1 similar comment
@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/luacmartins in version: 1.4.85-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/luacmartins in version: 1.4.85-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/AndrewGable in version: 1.4.85-7 🚀

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

@adamgrzybowski
Copy link
Contributor

@luacmartins @bernhardoj It looks like I missed one thing during review.

We had this comment in the code

// On narrow layout, if we are on /search route we want to hide all central pane routes and show only the bottom tab navigator.

And it's no longer true after the changes. This caused problem in this PR when navigating from settings/subscription to search page

We need to create additional if to bring back the previous behavior. Something like that seems to work:

if (isSmallScreenWidth) {
  const isSearchCentralPane = (route: RouteProp<ParamListBase>) => getTopmostCentralPaneRoute({routes: [route]} as State<RootStackParamList>)?.name === SCREENS.SEARCH.CENTRAL_PANE;
  
  const lastRoute = routes[routes.length - 1];
  const lastSearchCentralPane = isSearchCentralPane(lastRoute) ? lastRoute : undefined;
  const filteredRoutes = routes.filter((route) => !isSearchCentralPane(route));
  
  // On narrow layout, if we are on /search route we want to hide all central pane routes and show only the bottom tab navigator. 
  if (lastSearchCentralPane) {
    return {
      stateToRender: {
        ...state,
        index: 0,
        routes: [filteredRoutes[0]],
      },
      searchRoute: lastSearchCentralPane,
    };
  }
  
  return {
    stateToRender: {
      ...state,
      index: filteredRoutes.length - 1,
      routes: filteredRoutes,
    },
    searchRoute: undefined,
  };
}

@bernhardoj
Copy link
Contributor Author

@adamgrzybowski ah, my bad. I can repro the issue and confirmed bring back the previous code solves it. But I'm thinking of an alternative, that is, when we navigate to the search page on a small screen, pop all stack. We will put the code here:

// 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 (isOpeningSearch && isNarrowLayout) {
    root.dispatch({
        type: 'POP_TO_TOP',
        target: rootState.key,
    });
}

This is consistent with how we handle navigating to the bottom nav too.

} else {
// If the layout is small we need to pop everything from the central pane so the bottom tab navigator is visible.
root.dispatch({
type: 'POP_TO_TOP',
target: rootState.key,
});
}

What do you think? I can raise the fix tomorrow.

@luacmartins
Copy link
Contributor

@bernhardoj's approach seems fine to me. @adamgrzybowski what do you think?

@adamgrzybowski
Copy link
Contributor

@bernhardoj Hi! Sorry for the late reply. The approach with POP_TO_TOP may lead to different behavior on the web and mobile after pressing the back button. Additionally, we are losing history which is not good. I know the current approach isn't pretty but I don't think POP_TO_TOP is the right answer.

@bernhardoj
Copy link
Contributor Author

Ah, that makes sense. I see that #44119 already apply the fix. Thanks for the help! 🙇

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.

5 participants