Skip to content

Refactor provided component to use useSearchSelector hook and remove unused and duplicated code (Task 2)#71482

Merged
pecanoro merged 9 commits intoExpensify:mainfrom
daledah:fix/71059
Oct 29, 2025
Merged

Refactor provided component to use useSearchSelector hook and remove unused and duplicated code (Task 2)#71482
pecanoro merged 9 commits intoExpensify:mainfrom
daledah:fix/71059

Conversation

@daledah
Copy link
Contributor

@daledah daledah commented Sep 29, 2025

Explanation of Change

Refactor the provided component to use the useSearchSelector hook and remove unused and duplicated code.
Components:

  1. BaseShareLogList

Fixed Issues

$ #71059
PROPOSAL:

Tests

  1. Open settings -> Troubleshoot
  2. Enable Record Troubleshoot Data
  3. Click View Debug Console -> Share Log
  4. Verify that: options is displayed in correct order, no duplicate item is shown
  5. Try typing something that will return no results
  6. Verify that: "No results found" message is displayed
  7. Try select one of the option
  8. Verify that: We are navigated to the correct report
  9. Verify that: Log file is sent correctly
  • Verify that no errors appear in the JS console

Offline tests

QA Steps

  1. Open settings -> Troubleshoot
  2. Enable Record Troubleshoot Data
  3. Click View Debug Console -> Share Log
  4. Verify that: options is displayed in correct order, no duplicate item is shown
  5. Try typing something that will return no results
  6. Verify that: "No results found" message is displayed
  7. Try select one of the option
  8. Verify that: We are navigated to the correct report
  9. Verify that: Log file is sent correctly
  • 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 verified there are no new alerts related to the canBeMissing param for useOnyx
  • 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 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 used JaimeGPT to get English > Spanish translation. I then posted it 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.ts 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 new assets were added or existing ones were modified, I verified that:
    • The assets are optimized and compressed (for SVG files, run npm run compress-svg)
    • The assets load correctly across all supported platforms.
  • 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.
  • I added unit tests for any new feature or bug fix in this PR to help automatically prevent regressions in this user 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 the Test steps.

Screenshots/Videos

Android: Native
Screen.Recording.2025-10-13.at.02.10.21.mp4
Android: mWeb Chrome
Screen.Recording.2025-10-13.at.02.25.51.mov
iOS: Native
Screen.Recording.2025-10-13.at.02.27.10.mov
iOS: mWeb Safari
Screen.Recording.2025-10-13.at.02.28.24.mp4
MacOS: Chrome / Safari
Screen.Recording.2025-10-13.at.02.29.25.mp4
MacOS: Desktop
Screen.Recording.2025-10-13.at.02.30.55.mp4

@codecov
Copy link

codecov bot commented Sep 29, 2025

Codecov Report

❌ Patch coverage is 0% with 9 lines in your changes missing coverage. Please review.

Files with missing lines Patch % Lines
...ttings/AboutPage/ShareLogList/BaseShareLogList.tsx 0.00% 7 Missing ⚠️
src/hooks/useSearchSelector.base.ts 0.00% 2 Missing ⚠️
Files with missing lines Coverage Δ
src/CONST/index.ts 85.71% <ø> (ø)
src/libs/OptionsListUtils/index.ts 71.62% <ø> (-0.16%) ⬇️
src/hooks/useSearchSelector.base.ts 0.00% <0.00%> (ø)
...ttings/AboutPage/ShareLogList/BaseShareLogList.tsx 0.00% <0.00%> (ø)

... and 10 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@daledah
Copy link
Contributor Author

daledah commented Oct 2, 2025

I want to ask for confirmation about the following case:

When search string is empty, we show 2 Concierge options in staging:

Screenshot 2025-10-02 at 23 36 30

When search for "Concierge", here's the result:

This PR Staging
Screenshot 2025-10-02 at 23 37 56 Screenshot 2025-10-02 at 23 37 49

The inconsistency is that for New chat page, there's only 1 Concierge option:

Screenshot 2025-10-02 at 23 40 14

So what I want to confirm is: Should we display "Concierge" in "Contacts" section if it already exist in "Recents" section?

@daledah daledah marked this pull request as ready for review October 2, 2025 16:42
@daledah daledah requested a review from a team as a code owner October 2, 2025 16:42
@melvin-bot melvin-bot bot requested a review from akinwale October 2, 2025 16:42
@melvin-bot
Copy link

melvin-bot bot commented Oct 2, 2025

@akinwale 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 removed the request for review from a team October 2, 2025 16:42
@sosek108
Copy link
Contributor

sosek108 commented Oct 3, 2025

@daledah please, read task description and check if you applied this part

Important notes:

  1. you can use InviteReportParticipantsPage as an example of the implementation
  2. you should create new const value to use as context param: CONST.SEARCH_SELECTOR.SEARCH_CONTEXT_SHARE_LOG
  3. you need to ensure all functionalities are working correctly. Especially: selection, filtering, ordering, and inviting new users
  4. After refactoring, we can remove getShareLogOptions

You should modify switch inside useSearchSelector to accept SEARCH_CONTEXT_SHARE_LOG and this one should usegetValidOptions method configured the similar way as it's in getShareLogOptions

Please ensure that in test steps these are covered:

  1. correct order of contacts
  2. correct filtering
  3. correct behaviour when you write nothing is found
  4. selection works
  5. seleceted items are not displayed in Contacts / Reports
  6. correct message is displayed when nothing is found by query

@sosek108
Copy link
Contributor

sosek108 commented Oct 3, 2025

So what I want to confirm is: Should we display "Concierge" in "Contacts" section if it already exist in "Recents" section?

no. this is clearly a bug

@daledah
Copy link
Contributor Author

daledah commented Oct 3, 2025

@sosek108 Thanks for the clarification! I'll update the PR soon.

@akinwale
Copy link
Contributor

@daledah Please fix merge conflicts.

@sosek108
Copy link
Contributor

@daledah new conflicts

@sosek108
Copy link
Contributor

@daledah could you please verify that getShareLogOptions can be removed.

As description states it should be removed. If you cannot remove, please state why

@daledah
Copy link
Contributor Author

daledah commented Oct 16, 2025

@sosek108 Currently there's only one usage of getShareLogOptions in the App, but there's 2 test cases for it:

test('[OptionsListUtils] getShareLogOptions', async () => {
await waitForBatchedUpdates();
await measureFunction(() => getShareLogOptions(options, {}, mockedBetas));
});

describe('getShareLogOptions()', () => {
it('should not include read-only report', () => {
// Given a list of 11 report options with reportID of 10 is archived
// When we call getShareLogOptions
const results = getShareLogOptions(OPTIONS, {}, []);
// Then the report with reportID of 10 should not be included on the list
expect(results.recentReports.length).toBe(10);
expect(results.recentReports.find((report) => report.reportID === '10')).toBeUndefined();
});
});

I think it's fine to remove this util and replace the tests with the actual call instead:

return getValidOptions(
options,
draftComments,
{
betas,
includeMultipleParticipantReports: true,
includeP2P: true,
forcePolicyNamePreview: true,
includeOwnedWorkspaceChats: true,
includeSelfDM: true,
includeThreads: true,
includeReadOnly: false,
searchString,
maxElements,
includeUserToInvite,
},
countryCode,
);

What are your thoughts on this?

@daledah
Copy link
Contributor Author

daledah commented Oct 22, 2025

@sosek108 Friendly bump on #71482 (comment)

@sosek108
Copy link
Contributor

@daledah I think that we can remove tests that test function. I'm pretty sure that getValidOptions is thoroughly tested

@daledah
Copy link
Contributor Author

daledah commented Oct 23, 2025

I updated!

@akinwale
Copy link
Contributor

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 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: HybridApp
    • Android: mWeb Chrome
    • iOS: HybridApp
    • 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 there are no new alerts related to the canBeMissing param for useOnyx
  • 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 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.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. 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.
  • 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 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: HybridApp
71482-android-hybrid.mp4
Android: mWeb Chrome
71482-android-chrome.mp4
iOS: HybridApp
71482-ios-hybrid.mp4
iOS: mWeb Safari
71482-ios-safari.mp4
MacOS: Chrome / Safari
71482-web.mp4
MacOS: Desktop
71482-desktop.mp4

Copy link
Contributor

@akinwale akinwale 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 pecanoro October 28, 2025 17:08
@pecanoro pecanoro merged commit ea3bce9 into Expensify:main Oct 29, 2025
25 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/pecanoro in version: 9.2.41-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/puneetlath in version: 9.2.41-6 🚀

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

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