Add backTo param handling when opening Report from Search #49641

Kicu · 2024-09-24T11:33:31Z

Details

Adds backTo param to /search/view/<reportID> route, so that App knows what search query to go back to
had to fix existing logic handling backTo param in navigation
standardised a few methods in SearchUtils

Note: This concerns mostly web where you can refresh a page page, and refreshing would clear search history; Only web recording is provided as you cannot "refresh" a native app

Fixed Issues

$ #48817
PROPOSAL:

Tests

Go to Search option from bottom tab
Click on "Chat" type from LHP or use custom advanced filters
Click on any item from the rendered results
When the report view is opened in RHP refresh the browser
Verify that the the screen underneath is the same as the one chosen
Make sure back button works

Offline tests

QA Steps

Go to Search option from bottom tab
Click on "Chat" type from LHP or use custom advanced filters
Click on any item from the rendered results
When the report view is opened in RHP refresh the browser
Verify that the the screen underneath is the same as the one chosen
Make sure back button works

PR Author Checklist

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

rec-web-backTo.mp4

MacOS: Desktop

melvin-bot · 2024-09-24T12:09:55Z

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

Kicu · 2024-09-24T13:36:35Z

src/ROUTES.ts

@@ -1552,6 +1550,12 @@ type Route = {

 type RoutesValidationError = 'Error: One or more routes defined within `ROUTES` have not correctly used `as const` in their `getRoute` function return value.';

+/**
+ * Represents all routes in the app as a union of literal strings.


I added this comment, because I found the RouteIsPlainString quite confusing. After digging in git blame I found that this comment was originally there, but got removed in here:
https://github.com/Expensify/App/pull/40017/files#diff-8c80af31c75a0f4fcb67272bd2df5b42c9611c040ecc66584fcd6bde05dbbd78L749

I think having this comment is much better than not having it, because this type is not exported and not used anywhere, so it will 100% confuse others.

ikevin127 · 2024-09-25T22:53:00Z

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.webm

Android: mWeb Chrome

android-mweb.webm

iOS: Native

ios.mp4

iOS: mWeb Safari

ios-mweb.mp4

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

luacmartins · 2024-09-26T01:05:58Z

src/components/Search/index.tsx

        if (SearchUtils.isReportActionListItemType(item)) {
            const reportActionID = item.reportActionID;
-            Navigation.navigate(ROUTES.SEARCH_REPORT.getRoute(reportID, reportActionID));
+            Navigation.navigate(ROUTES.SEARCH_REPORT.getRoute({reportID, reportActionID, backTo}));


Could we use Navigation.getActiveRoute() instead of passing the queryJSON.inputQuery and building the route? Same for the other instances of backTo in this PR

This is a great improvement Carlos! thanks, I tested and it works.

The only small difference is that if I generate backTo it looks like this: search?foo whereas generated from getActiveRoute() it has the extra leading slash: /search?foo.
But as far as I can see it makes no changes in navigation logic, so I'm fixing this 👍

Nice! Yea, I think that should be ok. Thanks for the changes!

ikevin127

LGTM 🚀

⚠️ Edit: Oups, looks like we have some conflicts!

luacmartins · 2024-09-26T23:43:34Z

We also have this pending comment

Kicu · 2024-09-27T08:34:05Z

Comment applied, conflicts resolved

luacmartins

LGTM

luacmartins · 2024-09-27T08:37:18Z

src/components/Search/index.tsx

        if (SearchUtils.isReportActionListItemType(item)) {
            const reportActionID = item.reportActionID;
-            Navigation.navigate(ROUTES.SEARCH_REPORT.getRoute(reportID, reportActionID));
+            Navigation.navigate(ROUTES.SEARCH_REPORT.getRoute({reportID, reportActionID, backTo}));


Nice! Yea, I think that should be ok. Thanks for the changes!

OSBotify · 2024-09-27T09:01:17Z

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

github-actions · 2024-09-27T18:00:17Z

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

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

github-actions · 2024-09-30T22:42:07Z

🚀 Deployed to production by https://github.com/jasperhuangg in version: 9.0.41-10 🚀

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

Kicu marked this pull request as ready for review September 24, 2024 12:09

Kicu requested a review from a team as a code owner September 24, 2024 12:09

melvin-bot bot requested review from ikevin127 and removed request for a team September 24, 2024 12:09

Add backTo param handling when opening Report from Search

d8cda53

Kicu force-pushed the kicu/48817-search-backto branch from 13d29fc to d8cda53 Compare September 24, 2024 12:33

Kicu commented Sep 24, 2024

View reviewed changes

luacmartins self-requested a review September 24, 2024 14:09

luacmartins reviewed Sep 26, 2024

View reviewed changes

ikevin127 approved these changes Sep 26, 2024

View reviewed changes

melvin-bot bot requested a review from luacmartins September 26, 2024 22:47

Kicu added 3 commits September 27, 2024 10:25

Simplify generating backTo param in Search

405a695

Merge branch 'main' into kicu/48817-search-backto

a1dd90d

Fix bug after merge conflict

43c4676

luacmartins approved these changes Sep 27, 2024

View reviewed changes

luacmartins merged commit 70ed492 into Expensify:main Sep 27, 2024
17 checks passed

github-actions bot mentioned this pull request Sep 27, 2024

Deploy Checklist: New Expensify 2024-09-27 #49855

Closed

lanitochka17 mentioned this pull request Sep 30, 2024

[Search v2.2] mWeb/Chrome Search-Navigate back to the top of messages instead of the selected message #49923

Closed

6 tasks

ikevin127 mentioned this pull request Sep 30, 2024

[HOLD for Payment 2024-10-07][$250] [Search v2.2] Redirected back to "Expenses" when refreshing the page while in "chats" #48817

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add backTo param handling when opening Report from Search #49641

Add backTo param handling when opening Report from Search #49641

Kicu commented Sep 24, 2024 •

edited

Loading

melvin-bot bot commented Sep 24, 2024

Kicu Sep 24, 2024

ikevin127 commented Sep 25, 2024 •

edited

Loading

luacmartins Sep 26, 2024

Kicu Sep 27, 2024

luacmartins Sep 27, 2024

ikevin127 left a comment •

edited

Loading

luacmartins commented Sep 26, 2024

Kicu commented Sep 27, 2024

luacmartins left a comment

luacmartins Sep 27, 2024

OSBotify commented Sep 27, 2024

github-actions bot commented Sep 27, 2024

github-actions bot commented Sep 30, 2024

Add backTo param handling when opening Report from Search #49641

Add backTo param handling when opening Report from Search #49641

Conversation

Kicu commented Sep 24, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Sep 24, 2024

Kicu Sep 24, 2024

Choose a reason for hiding this comment

ikevin127 commented Sep 25, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

luacmartins Sep 26, 2024

Choose a reason for hiding this comment

Kicu Sep 27, 2024

Choose a reason for hiding this comment

luacmartins Sep 27, 2024

Choose a reason for hiding this comment

ikevin127 left a comment • edited Loading

Choose a reason for hiding this comment

luacmartins commented Sep 26, 2024

Kicu commented Sep 27, 2024

luacmartins left a comment

Choose a reason for hiding this comment

luacmartins Sep 27, 2024

Choose a reason for hiding this comment

OSBotify commented Sep 27, 2024

github-actions bot commented Sep 27, 2024

github-actions bot commented Sep 30, 2024

Kicu commented Sep 24, 2024 •

edited

Loading

ikevin127 commented Sep 25, 2024 •

edited

Loading

ikevin127 left a comment •

edited

Loading