Skip to content

Refactor ONYXKEYS.NVP_ACTIVE_POLICY_ID in src/libs/OptionsListUtils.ts#70137

Open
parasharrajat wants to merge 4 commits intoExpensify:mainfrom
parasharrajat:onyx/66382
Open

Refactor ONYXKEYS.NVP_ACTIVE_POLICY_ID in src/libs/OptionsListUtils.ts#70137
parasharrajat wants to merge 4 commits intoExpensify:mainfrom
parasharrajat:onyx/66382

Conversation

@parasharrajat
Copy link
Copy Markdown
Member

@parasharrajat parasharrajat commented Sep 8, 2025

Explanation of Change

Fixed Issues

$ #66382
PROPOSAL:

Tests

  • Verify that no errors appear in the JS console

Offline tests

QA Steps

// TODO: These must be filled out, or the issue title must include "[No QA]."

  • 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
Android: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari
MacOS: Desktop

@parasharrajat parasharrajat marked this pull request as ready for review September 11, 2025 08:00
@parasharrajat parasharrajat requested a review from a team as a code owner September 11, 2025 08:00
@melvin-bot melvin-bot bot requested review from DylanDylann and removed request for a team September 11, 2025 08:00
@melvin-bot
Copy link
Copy Markdown

melvin-bot bot commented Sep 11, 2025

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

const personalDetailsWithoutDMs = filteredPersonalDetailsOfRecentReports(options.recentReports, options.personalDetails);
const reportsAndPersonalDetails = options.recentReports.concat(personalDetailsWithoutDMs);
return orderOptions({recentReports: reportsAndPersonalDetails, personalDetails: []}, searchInputValue, orderReportOptionsConfig);
return orderOptions({recentReports: reportsAndPersonalDetails, personalDetails: []}, activePolicyID ?? '', searchInputValue, orderReportOptionsConfig);
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do not default string IDs to any value

Copy link
Copy Markdown
Member Author

@parasharrajat parasharrajat Sep 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This parameter is required, so how do we manage that? I had to make this parameter required because of the different types this function support.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do not default string IDs to any value

This is lint error message 😄

Copy link
Copy Markdown
Member Author

@parasharrajat parasharrajat Sep 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But as I said, the param to the function is required but the activePolicyID is optional so we need to make sure it is not undefined but the value of this param can be empty which is a fine case.

So to satisfy ts, we need to pass a default value.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@DylanDylann What do you suggest on how we handle this?

Here are 2 variants of this function.

function orderOptions(options: ReportAndPersonalDetailOptions, activePolicyID?: string): ReportAndPersonalDetailOptions;

/**
 * Sorts reports and personal details independently, but prioritizes the search value.
 */
function orderOptions(options: ReportAndPersonalDetailOptions, activePolicyID: string, searchValue: string, config?: OrderReportOptionsConfig): ReportAndPersonalDetailOptions;
function orderOptions(options: ReportAndPersonalDetailOptions, activePolicyID?: string, searchValue?: string, config?: OrderReportOptionsConfig): ReportAndPersonalDetailOptions {

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@parasharrajat Why do we need to make activePolicyID as required while It could be undefined?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the second function declaration above, third param searchValue is required so we have to make second param required and as we need activePolicyID in all 3 declarations, I have to position it as second param.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you agree with this?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@parasharrajat Sorry for the delay. Thanks for bump

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Initially, this function overload provided type safety and improved IntelliSense. However, in this PR, the returned type was unified across the overloads.

Screenshot 2025-10-05 at 11 26 00

Because of that, the overload now seems redundant. I suggest removing it, which would also resolve the issue we’re facing here. Let me know what you think.

const optionList = getAttendeeOptions(options.reports, options.personalDetails, betas, attendees, recentAttendees ?? [], iouType === CONST.IOU.TYPE.SUBMIT, true, false, action);
if (isPaidGroupPolicy) {
const orderedOptions = orderOptions(optionList, searchTerm, {
const orderedOptions = orderOptions(optionList, activePolicyID ?? '', searchTerm, {
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do not default string IDs to any value.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here.

@DylanDylann
Copy link
Copy Markdown
Contributor

@parasharrajat Could you please fix failed GH actions?

@parasharrajat
Copy link
Copy Markdown
Member Author

I will update this PR next week.

@DylanDylann
Copy link
Copy Markdown
Contributor

@parasharrajat Any update?

parasharrajat and others added 3 commits September 30, 2025 16:50
@DylanDylann
Copy link
Copy Markdown
Contributor

@parasharrajat is this PR ready for review?

@parasharrajat
Copy link
Copy Markdown
Member Author

Yes, it is ready.

@DylanDylann
Copy link
Copy Markdown
Contributor

@parasharrajat Could you please merge latest main? I see there are lots of failed GH actions

@DylanDylann
Copy link
Copy Markdown
Contributor

@parasharrajat Also please add QA steps

@parasharrajat
Copy link
Copy Markdown
Member Author

I will update this PR soon. It might take 1-2 days due to some other things I am prioritizing over this.

@DylanDylann
Copy link
Copy Markdown
Contributor

@parasharrajat Kindly bump

@parasharrajat
Copy link
Copy Markdown
Member Author

Thanks for pjng. I will catch up here soon

@parasharrajat
Copy link
Copy Markdown
Member Author

Going to break this PR into multiples.

@DylanDylann
Copy link
Copy Markdown
Contributor

@parasharrajat Let's close this PR 😄 or make it draft

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.

2 participants