Skip to content

[Part 1] Refactor formatPhoneNumber from NextStepUtils#87288

Open
FitseTLT wants to merge 19 commits intoExpensify:mainfrom
FitseTLT:fix-refactor-formatPhoneNumber-NextStepUtils
Open

[Part 1] Refactor formatPhoneNumber from NextStepUtils#87288
FitseTLT wants to merge 19 commits intoExpensify:mainfrom
FitseTLT:fix-refactor-formatPhoneNumber-NextStepUtils

Conversation

@FitseTLT
Copy link
Copy Markdown
Contributor

@FitseTLT FitseTLT commented Apr 7, 2026

Explanation of Change

Replaced formatPhoneNumber in NextStepUtils from buildNextStepMessage, getNextApproverDisplayName, buildNextStepNew utils with formatPhoneNumber from useLocalize.

Fixed Issues

$ #66327
PROPOSAL:

Tests

This is a refactoring PR so you should test that it doesn't create a new behavior on:

  1. Create an expense on a workspace
  2. Verify the next step message is correct
  3. While submitting, approving, and paying the expense, verify the next step message on the header is correct.
  • Verify that no errors appear in the JS console

Offline tests

same as tests

QA Steps

same as tests

  • 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
  • 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
2026-04-08.00-29-22.mp4

@FitseTLT FitseTLT requested review from a team as code owners April 7, 2026 21:36
@melvin-bot melvin-bot Bot requested review from JmillsExpensify and shubham1206agra and removed request for a team April 7, 2026 21:36
@melvin-bot
Copy link
Copy Markdown

melvin-bot Bot commented Apr 7, 2026

@shubham1206agra 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 request for a team and JmillsExpensify April 7, 2026 21:36
@FitseTLT FitseTLT changed the title Refactor formatPhoneNumber from NextStepUtils [Part 1] Refactor formatPhoneNumber from NextStepUtils Apr 7, 2026
Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 1872caecdd

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

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

Comment thread src/libs/actions/IOU/Hold.ts Outdated
* Put expense on HOLD
*/
function putOnHold(transactionID: string, comment: string, initialReportID: string | undefined, isOffline: boolean, ancestors: Ancestor[] = []) {
function putOnHold(transactionID: string, comment: string, initialReportID: string | undefined, isOffline: boolean, ancestors: Ancestor[] = [], formatPhoneNumber: LocaleContextProps['formatPhoneNumber']) {
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P1 Badge Keep hold/unhold helpers backward compatible

This change makes formatPhoneNumber mandatory for putOnHold/unholdRequest, but several existing callers still use the old arity (for example src/pages/iou/HoldReasonPage.tsx, src/pages/Search/SearchHoldReasonPage.tsx, src/libs/ReportUtils.ts, src/hooks/useSelectedTransactionsActions.ts, and src/hooks/useSearchBulkActions.ts). In those paths, buildNextStepNew() receives undefined and getDisplayNameForParticipant() will call formatPhoneNumber(...), which can throw when users hold or unhold expenses.

Useful? React with 👍 / 👎.

Comment thread src/libs/actions/IOU/index.ts Outdated
hasViolations: boolean,
isASAPSubmitBetaEnabled: boolean,
reportCurrentNextStepDeprecated: OnyxEntry<OnyxTypes.ReportNextStepDeprecated>,
formatPhoneNumber: LocaleContextProps['formatPhoneNumber'],
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P1 Badge Keep approver actions compatible with existing pages

Requiring formatPhoneNumber here (and in addReportApprover) breaks current call sites that were not updated, including src/pages/ReportChangeApproverPage.tsx, src/pages/Search/SearchChangeApproverPage.tsx, src/pages/ReportAddApproverPage.tsx, and src/pages/Search/SearchAddApproverPage.tsx. Those flows can now pass undefined into next-step generation, which will fail when formatting participant logins during change-approver actions.

Useful? React with 👍 / 👎.

Comment thread src/libs/actions/Transaction.ts Outdated
reportNextStep?: OnyxEntry<ReportNextStepDeprecated>;
policyCategories?: OnyxEntry<PolicyCategories>;
allTransactions: OnyxCollection<Transaction>;
formatPhoneNumber: LocaleContextProps['formatPhoneNumber'];
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P1 Badge Avoid breaking changeTransactionsReport call sites

Making formatPhoneNumber required in changeTransactionsReport introduces a regression for existing callers that still pass the previous object shape (for example src/components/AddUnreportedExpenseFooter.tsx). That path now provides no formatter, so the deprecated next-step builder can crash while resolving participant display names during “move/add unreported expense” flows.

Useful? React with 👍 / 👎.

hasViolationsParam,
recentlyUsedReportFields,
shouldFixViolations = false,
formatPhoneNumber,
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P1 Badge Preserve updateReportField API compatibility

This makes formatPhoneNumber required for updateReportField, but src/pages/EditReportFieldPage.tsx still calls it without that property. As a result, editing a report field can pass undefined into next-step building and fail when display-name formatting is executed.

Useful? React with 👍 / 👎.

@FitseTLT FitseTLT marked this pull request as draft April 7, 2026 21:59
@FitseTLT FitseTLT closed this Apr 20, 2026
@FitseTLT FitseTLT reopened this Apr 21, 2026
@FitseTLT FitseTLT marked this pull request as ready for review April 21, 2026 19:21
@FitseTLT
Copy link
Copy Markdown
Contributor Author

This is ready for review @shubham1206agra

@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 21, 2026

Codecov Report

✅ Changes either increased or maintained existing code coverage, great job!

Files with missing lines Coverage Δ
.../components/MoneyReportHeaderEducationalModals.tsx 0.00% <ø> (ø)
...ortHeaderPrimaryAction/RemoveHoldPrimaryAction.tsx 0.00% <ø> (ø)
src/components/MoneyRequestHeaderPrimaryAction.tsx 3.70% <ø> (ø)
src/hooks/useHoldRejectActions.ts 0.00% <ø> (ø)
src/hooks/useSearchBulkActions.ts 47.60% <ø> (ø)
src/hooks/useSelectedTransactionsActions.ts 75.90% <100.00%> (ø)
src/libs/ReportUtils.ts 82.56% <100.00%> (+0.13%) ⬆️
src/libs/actions/IOU/Hold.ts 93.62% <100.00%> (+0.03%) ⬆️
src/libs/actions/IOU/PayMoneyRequest.ts 78.65% <100.00%> (ø)
src/libs/actions/IOU/PerDiem.ts 69.32% <100.00%> (ø)
... and 16 more
... and 45 files with indirect coverage changes

@shubham1206agra
Copy link
Copy Markdown
Contributor

@FitseTLT Keep the number of file changes small. It will be super hard to review 91 files

@FitseTLT
Copy link
Copy Markdown
Contributor Author

@FitseTLT Keep the number of file changes small. It will be super hard to review 91 files

But it is one function that lead to all these changes I don't how I can still narrow down the scope. U told me to check previous prs and they refactor a function per pr I did the same here. Both buildNextStepMessage, getNextApproverDisplayName have almost 2 file change all the other changes is related with buildNextStepNew I don't know how I could do it better. May be the best idea is for you (as a C+) to work with melvin.

@shubham1206agra
Copy link
Copy Markdown
Contributor

@FitseTLT Make the parameter as an optional parameter with default value being the deprecated function. Then, do the gradual migration.

@FitseTLT
Copy link
Copy Markdown
Contributor Author

I think it is enough now.

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