[No QA]: refactor: extract SearchUpdate.ts from IOU/index.ts#89590
[No QA]: refactor: extract SearchUpdate.ts from IOU/index.ts#89590DylanDylann wants to merge 2 commits intoExpensify:mainfrom
Conversation
|
@parasharrajat 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] |
Codecov Report❌ Looks like you've decreased code coverage for some files. Please write tests to increase, or at least maintain, the existing level of code coverage. See our documentation here for how to interpret this table.
|
ad3e6d8 to
7ca8fb0
Compare
Extracts search-snapshot optimistic-update helpers (shouldOptimisticallyUpdateSearch, getSearchOnyxUpdate) along with their supporting type and predicate map into a dedicated SearchUpdate module. Function bodies are byte-identical to their pre-move state on main. The new module sets up its own Onyx subscriptions to SESSION and PERSONAL_DETAILS_LIST (mirroring index.ts) so it does not need to import from index.ts — this avoids the import/no-cycle violation that would arise because index.ts itself calls getSearchOnyxUpdate (inside buildOnyxDataForMoneyRequest). The two new deprecated-Onyx.connect violations are added to eslint-seatbelt.tsv. Part of Issue Expensify#72804 (break up src/libs/actions/IOU/).
7ca8fb0 to
4792b42
Compare
parasharrajat
left a comment
There was a problem hiding this comment.
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 Issuessection 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
Testssection - I verified the steps for Staging and/or Production testing are in the
QA stepssection - 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: HybridApp
- Android: mWeb Chrome
- iOS: HybridApp
- iOS: mWeb Safari
- MacOS: Chrome / Safari
- 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.
toggleReportand 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 usingAvatarhave 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
thisproperly so there are no scoping issues (i.e. foronClick={this.submit}the methodthis.submitshould be bound tothisin the constructor) - Any internal methods bound to
thisare necessary to be bound (i.e. avoidthis.submit = this.submit.bind(this);ifthis.submitis 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
Avataris modified, I verified thatAvataris 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
Designlabel and/or tagged@Expensify/designso the design team can review the changes.
- If a new page is added, I verified it's using the
ScrollViewcomponent 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
mainbranch was merged into this PR after a review, I tested again and verified the outcome was still expected according to theTeststeps. - I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.
🎀 👀 🎀 C+ reviewed
|
We got an import cycle |
…-search-update # Conflicts: # src/libs/actions/IOU/SendInvoice.ts # src/libs/actions/IOU/TrackExpense.ts # src/libs/actions/IOU/index.ts # tests/actions/IOUTest.ts
|
@parasharrajat Could you review again? |
|
@codex review |
|
Codex Review: Didn't find any major issues. Can't wait for the next one! ℹ️ About Codex in GitHubCodex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you
If Codex has suggestions, it will comment; otherwise it will react with 👍. When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback". |
|
@parasharrajat Kindly bump |
Explanation of Change
Part of #72804 — breaking up
src/libs/actions/IOU/. Independent of (and parallel to) theNavigationHelpers.tsextraction (PR D); both touchindex.tsbut in disjoint regions.This PR extracts the search-snapshot optimistic-update helpers (
shouldOptimisticallyUpdateSearch,getSearchOnyxUpdate) along with their supporting type and predicate map into a new dedicated moduleSearchUpdate.ts. Function bodies are byte-identical to their pre-move state onmain.Cycle-avoidance note
index.tsitself callsgetSearchOnyxUpdateinsidebuildOnyxDataForMoneyRequest, so ifSearchUpdate.tsimported anything fromindex.tswe would create animport/no-cycleviolation. To keepSearchUpdate.tscycle-free, the new module sets up its own Onyx subscriptions toONYXKEYS.SESSIONandONYXKEYS.PERSONAL_DETAILS_LIST— mirroring the pattern already inindex.tsfordeprecatedUserAccountID/deprecatedCurrentUserPersonalDetails. The two newOnyx.connect()lint violations are added toeslint.seatbelt.tsv(consistent with the existing 11 such grandfathered violations inIOU/index.ts). State stays in sync because both subscriptions receive the same Onyx callbacks.New file:
src/libs/actions/IOU/SearchUpdate.ts(~225 lines):ExpenseReportStatusPredicateexpenseReportStatusFilterMappingGetSearchOnyxUpdateParamsshouldOptimisticallyUpdateSearchgetSearchOnyxUpdateConsumer files updated:
src/libs/actions/IOU/index.ts— drops the moved declarations, drops 4 now-unused imports (SearchQueryJSON,isOptimisticPersonalDetail,buildSearchQueryJSON/Query/CurrentSearchQueryJSON,getSuggestedSearches,SearchResultDataType), adds named import ofgetSearchOnyxUpdatefrom the new module, drops the two names from its export block.src/libs/actions/IOU/TrackExpense.ts— re-pointsgetSearchOnyxUpdateimport.src/libs/actions/IOU/SendInvoice.ts— re-pointsgetSearchOnyxUpdateimport.tests/actions/IOUTest.ts— re-pointsshouldOptimisticallyUpdateSearchimport.config/eslint/eslint.seatbelt.tsv— registersSearchUpdate.tswith budget of 2 forrulesdir/no-onyx-connect.Fixed Issues
$ #72804
Tests
tests/actions/IOUTest.tsandtests/actions/IOUTest/SplitTest.tspass without modification (190/190)Offline tests
N/A — refactor only, no behavioral changes.
QA Steps
PR Author Checklist
### Fixed Issuessection aboveTestssectionOffline stepssectionQA stepssectiontoggleReportand notonIconClick)src/languages/*files and using the translation methodSTYLE.md) were followedAvatar, I verified the components usingAvatarare working as expected)StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))npm run compress-svg)Avataris modified, I verified thatAvataris working as expected in all cases)Designlabel and/or tagged@Expensify/designso the design team can review the changes.mainbranch was merged into this PR after a review, I tested again and verified the outcome was still expected according to theTeststeps.Screenshots/Videos
N/A — refactor only, no UI changes.