[No QA] Split SearchUtils into two files

[Kicu]

Details

• this is purely a code refactor, the exact details are described in the issue
• SearchUtils were split into two files, no logic changes were done

@luacmartins I went with your suggestion for the SearchUIUtils name, but I kept SearchQuery name; almost all functions inside this file have the word "query" inside and they mostly transform different forms of query. I think adding the word syntaxto the mix right now would actually be more confusing

App works without problems:

recc.mov

Fixed Issues

$ #50787
PROPOSAL:

Tests

• verify that all the TS and lint checks pass and App works

Offline tests

QA Steps

N/A Only code changes and renames in this PR; no logic changed

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

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

[melvin-bot]

@rayane-djouah 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]

[289Adam289]

Nice improvement to code structure

[rayane-djouah]

Suggestions:

1. Would you like to address comments from add display name replacement and make search page router editable #49838 (review) in this PR?

2. Rename SearchQueryUtils.getSearchHeaderTitle (which represented the static header title before, but now it's representing the initial value of the search query input on the search results page) to SearchQueryUtils.getInitialSearchInputValue.

3. Rename SearchQueryUtils.buildFilterString to SearchQueryUtils.buildFilterValuesString.

4. Add doc comments for functions in SearchQueryUtils, for example:

/**
 * Sanitizes a string by escaping special characters, placing quotes around strings that contain invalid characters.
 */
function sanitizeString() { }

/**
 * Parses a given search query string into a structured JSON format suitable for further processing.
 */
function buildSearchQueryJSON() { }

/**
 * Constructs a search query string from a search query JSON object.
 */
function buildSearchQueryString() { }

/**
 * Constructs a query string from the values provided in the search filters form.
 */
function buildQueryStringFromFilterFormValues() { }

/**
 * Replaces the IDs for values in a specific filter with display values.
 */
function getDisplayValue() { }

/**
 * Constructs the filter values part of the query string for a specific filter.
 */
function buildFilterString() { }

/**
 * Constructs a predefined (canned) search query string, typically used for standard searches that only specify type and status.
 */
function buildCannedSearchQuery() { }

/**
 * Standardizes a search query JSON object by replacing display values with their corresponding IDs.
 */
function standardizeQueryJSON() { }

/**
 * Constructs a contextual suggestion query for the Search in <Report name> search router option.
 */
function getContextualSuggestionQuery() { }

5. Add doc comments for functions in SearchUIUtils, examples:

/**
 * Determines whether to display the merchant field based on the transactions in the search results.
 */
function getShouldShowMerchant() { }

/**
 * Checks if the date of transactions or reports indicate the need to display the year because they are from a past year.
 */
function shouldShowYear() { }

/**
 * Organizes transaction data into sections for display, handling formatting and visibility of details like merchants and years.
 */
function getTransactionsSections() { }

/**
 * Formats and organizes report action data into sections for display based on report actions.
 */
function getReportActionsSections() { }

/**
 * Generates a display name for IOU reports considering the personal details of the payer and the transaction details.
 */
function getIOUReportName() { }

/**
 * Aggregates and organizes report data into sections for display, including transaction and IOU details.
 */
function getReportSections() { }

/**
 * Selects the appropriate list item component based on the type and status of the search data.
 */
function getListItem() { }

/**
 * Organizes data into appropriate sections for displaying based on the type of search data and status.
 */
function getSections() { }

/**
 * Orders sections of data based on a specified column and order direction for displaying sorted results.
 */
function getSortedSections() { }

/**
 * Sorts transaction data by a specified column and direction, affecting how transactions are ordered in the display.
 */
function getSortedTransactionData() { }

/**
 * Determines the date of the newest transaction within a report for sorting purposes.
 */
function getReportNewestTransactionDate() { }

/**
 * Sorts report data based on the date of the newest transaction in each report to order them appropriately.
 */
function getSortedReportData() { }

/**
 * Sorts report action data based on their creation dates to order actions chronologically.
 */
function getSortedReportActionData() { }

/**
 * Checks if the search results contain any data, useful for determining if the search results are empty.
 */
function isSearchResultsEmpty() { }

/**
 * Maps an expense type to its corresponding translation key for displaying localized text.
 */
function getExpenseTypeTranslationKey() { }

/**
 * Constructs and configures the overflow menu for search items, handling interactions such as renaming or deleting items.
 */
function getOverflowMenu() { }

/**
 * Validates the appropriateness of a user display name, excluding generic or placeholder names.
 */
function isCorrectSearchUserName() { }

[rayane-djouah]

Since the getSearchHeaderTitle function constructs the query string for display and is solely related to UI, shouldn't we move it from SearchQueryUtils to SearchUIUtils?

[Kicu]

@rayane-djouah sounds like good idea, I will add these updates later and ping you to re-echeck

[Kicu]

@rayane-djouah
Re 1: most of these are/will be handled by @289Adam289 in this draft: #50883 so I won't be touching them

Re 2: completely agree that getSearchHeaderTitle kinda lost it's meaning, but it is used in multiple places not only in Input, so I think I will try to come up with an even better name for it.

3,4 - will fix

And about this:

Since the getSearchHeaderTitle function constructs the query string for display and is solely related to UI,

I partially agree, from the perspective of what it returns it's UI. But what it works on is SearchQuery and it's result will be further used to allow the user to modify said query. That is why I put it there.
As of now the file SearchUIUtils basically doesn't use SearchQuery related types - perhaps that is a good enough reason to keep it as is?

[Kicu]

PR ready for re-check. I tried to add jsdoc for every single search utils method, hopefully I didn't miss any 😅

[Kicu]

@rayane-djouah please re-review when you have time.

However let's prioritise the polish issues: #50921 and merge polish before this PR, because it will cause conflicts in SearchUtils file

[rayane-djouah]

We have conflicts

[Kicu]

@rayane-djouah conflicts solved, they were a bit tricky since Jakub changed the original SearchUtils, so I made sure the query hash function was properly copied.

[luacmartins]

LGTM and tests well

[luacmartins]

LGTM. Thanks for working on this.

[rayane-djouah]

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

Screen.Recording.2024-10-23.at.12.42.02.AM.mov

Android: mWeb Chrome

Screen.Recording.2024-10-23.at.12.39.57.AM.mov

iOS: Native

Simulator.Screen.Recording.-.iPhone.15.Pro.Max.-.2024-10-23.at.00.39.35.mp4

iOS: mWeb Safari

Simulator.Screen.Recording.-.iPhone.15.Pro.Max.-.2024-10-23.at.00.38.30.mp4

MacOS: Chrome / Safari

Screen.Recording.2024-10-23.at.12.14.44.AM.mov

MacOS: Desktop

Screen.Recording.2024-10-23.at.12.35.23.AM.mov

[melvin-bot]

@luacmartins looks like this was merged without a test passing. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

[luacmartins]

tests were passing

[OSBotify]

✋ 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]

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

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

[github-actions]

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

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

[github-actions]

🚀 Deployed to production by https://github.com/yuwenmemon in version: 9.0.53-1 🚀

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

[github-actions]

🚀 Deployed to production by https://github.com/yuwenmemon in version: 9.0.53-1 🚀

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