-
Notifications
You must be signed in to change notification settings - Fork 3.2k
[Better Expense Report View] Add new navigator to allow for new SearchMoneyRequestReport screen #57607
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
[Better Expense Report View] Add new navigator to allow for new SearchMoneyRequestReport screen #57607
Conversation
66c316d
to
beb8f01
Compare
I will fix tests on Monday, because I need to consult with @WojtekBoman who wrote navigation tests. |
beb8f01
to
6d20d34
Compare
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.
Configuration of the nav looks good to me!
@allgandalf @DylanDylann who will take this one? @Kicu Dm me in slack when this is ready for a build and testing by C+ |
I can! |
@allgandalf Thanks, I will take care the next PR |
13e60cf
to
c0bd8fe
Compare
Quick update from me: since today @WojtekBoman is back from his holidays, I was able to sync with him and he pointed out a few small things that were wrong in this PR. So I'm currently fixing those and also fixing tests, and I should be done in a few hours. So I will open this for review later today. |
850b2b3
to
6eab33e
Compare
6eab33e
to
3bfa585
Compare
@allgandalf @mountiny this is basically ready to be reviewed but there is 1 known bug which I'm unable to fix today. There is something wrong with navigation state when we do I need to talk some more with @WojtekBoman tomorrow and I will have it fixed. |
@ishpaul777 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] |
@allgandalf you are already reviewing this PR right? Do you need my help in anything or should I ignore this? |
* TODO | ||
* This is a completely temporary component, displayed to: | ||
* - show other devs that SearchMoneyRequestReportPage works | ||
* - unblock work for other devs for Report Creation |
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.
Feel free to link the issues (or tracking issue of the project here)
if (!queryJSON) { | ||
return null; | ||
} | ||
if (lastRoute?.name === NAVIGATORS.SEARCH_FULLSCREEN_NAVIGATOR) { |
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.
Please, try to add more comments to this code
src/ROUTES.ts
Outdated
getRoute: ({reportID, backTo}: {reportID: string | undefined; backTo?: string}) => { | ||
if (!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.
@Kicu what would be the case where we do not have a reportID yet we route to SEARCH_MONEY_REQUEST_REPORT
?
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.
actually I think there is no point to this and we can remove this if check.
I expect react-navigation to handle missing reportID
, but we always should navigate to direct /report/id
.
Thanks for pointing this 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.
code LGTM, thanks for the requested change @Kicu , completing checklist now 🚀
@allgandalf let me know when you're done with the checklist |
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.
Changes look good to me
@@ -71,17 +71,26 @@ describe('Switch policy ID', () => { | |||
expect(lastRouteAfterSwitch?.params).toMatchObject({policyID: '1'}); | |||
}); | |||
|
|||
it('from the Search page', () => { | |||
// Fixme fix as a followup to https://github.com/Expensify/App/issues/57508 once more important things are done | |||
it.skip('from the Search 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.
Created an isssue to fix this later so we do not forget about it #57889
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.
LGTM
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 that the composer does not automatically focus or open the keyboard on mobile unless explicitly intended. This includes checking that returning the app from the background does not unexpectedly open the keyboard.
- 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 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
- 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.ts 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 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. - For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this flow.
- 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.
Screenshots/Videos
Android: Native
Screen.Recording.2025-03-06.at.8.47.00.AM.mov
Android: mWeb Chrome
Screen.Recording.2025-03-06.at.8.48.26.AM.mov
iOS: Native
Screen.Recording.2025-03-06.at.8.50.25.AM.mov
iOS: mWeb Safari
Screen.Recording.2025-03-06.at.8.51.50.AM.mov
MacOS: Chrome / Safari
Screen.Recording.2025-03-06.at.8.44.18.AM.mov
MacOS: Desktop
Screen.Recording.2025-03-06.at.8.47.45.AM.mov
are we ready for merge now @vit @luacmartins? |
Yea, let's ship this! |
✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release. |
🚀 Deployed to staging by https://github.com/luacmartins in version: 9.1.10-0 🚀
|
@@ -73,7 +73,7 @@ function getMatchingFullScreenRoute(route: NavigationPartialRoute, policyID?: st | |||
const paramsFromRoute = getParamsFromRoute(SCREENS.SEARCH.ROOT); | |||
|
|||
return { | |||
name: SCREENS.SEARCH.ROOT, | |||
name: NAVIGATORS.SEARCH_FULLSCREEN_NAVIGATOR, |
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.
@Kicu This doesn't feel right. Can you please look into this? Since it's a bit different structure now for search. We can see the code for other navigators below.
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 doesn't feel right. Can you please look into this?
Can you be more specific? what exactly doesn't feel right and what problems this could cause?
🚀 Deployed to production by https://github.com/mountiny in version: 9.1.10-6 🚀
|
FYI, this caused issue #57984. In this PR, the search screen is added inside a search full screen navigator but the logic here for
This is fixed in PR #58008 |
shouldShowOfflineIndicatorInWideScreen | ||
offlineIndicatorStyle={styles.mtAuto} |
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.
Adding these lines caused #57966.
@@ -110,22 +80,6 @@ function BottomTabBar({selectedTab, isTooltipAllowed = false}: BottomTabBarProps | |||
} | |||
clearSelectedText(); | |||
interceptAnonymousUser(() => { | |||
const rootState = navigationRef.getRootState() as State<RootNavigatorParamList>; |
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 removed the logic of getting the last search route and configured the query parameter for the new search page with the last query parameter from the last search page here. Then we always navigate to the search page with the default query when we click on the search page
This caused #57986
report={report} | ||
policy={policy} | ||
/> | ||
</View> |
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.
<PopoverReactionList>
component was required here for opening the reactions modal on right click. This was fixed in #60257.
shouldShowOfflineIndicatorInWideScreen | ||
offlineIndicatorStyle={styles.mtAuto} | ||
shouldEnableMaxHeight | ||
headerGapStyles={styles.searchHeaderGap} |
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 added styles.searchHeaderGap
but did not remove the <HeaderGap />
component causing #59194.
This is the first part of adding new MoneyRequestReportView to the app.
Important: The new route added in this PR is not exposed to end users in any way as it's not linked to from anywhere in the App.
Explanation of Change
SearchFullscreenNavigator
.NAVIGATOR
for search on top level, whereas in the past it was SearchSCREEN
SearchFullscreenRouter
- it's needed because we have special logic in this app for handling policyID, and we need to grab it from search route params and updateFixed Issues
$ #57508
$ #57068
PROPOSAL:
Tests
/search
,/search/filters
should work same as always/search/report/<correct_report_id>
and confirm that new route is working correctly/search
Offline tests
QA Steps
Note: because this PR adds dev-only stuff, no new features affect end user
Check that search didn't break:
/search
,/search/filters
should work same as always/search
PR Author Checklist
### Fixed Issues
section aboveTests
sectionOffline steps
sectionQA steps
sectiontoggleReport
and notonIconClick
)src/languages/*
files and using the translation methodSTYLE.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 and/or tagged@Expensify/design
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
rec-andr-navigator.mp4
Android: mWeb Chrome
iOS: Native
rec-ios-navigator.mp4
iOS: mWeb Safari
rec-ios-mweb-navigator.mp4
MacOS: Chrome / Safari
rec-web-navigator.mp4
policyID:
rec-search-policy-web.mp4
MacOS: Desktop