Refactor TrackExpense function #55261

mkzie2 · 2025-01-15T10:13:37Z

Explanation of Change

Refactor TrackExpense function

Fixed Issues

$ #55230
PROPOSAL: #55230 (comment)

Tests

Login in an account that has the selfDM
Create a track expense
Verify that the track expense is created successfully with the correct data

Verify that no errors appear in the JS console

Offline tests

Same

QA Steps

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

Login in an account that has the selfDM
Create a track expense
Verify that the track expense is created successfully with the correct data

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 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 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-01-15.at.16.51.52.mov

Android: mWeb Chrome

Screen.Recording.2025-01-15.at.16.44.27.mov

iOS: Native

Screen.Recording.2025-01-15.at.17.12.01.mov

iOS: mWeb Safari

Screen.Recording.2025-01-15.at.16.42.51.mov

MacOS: Chrome / Safari

Screen.Recording.2025-01-15.at.16.41.00.mov

MacOS: Desktop

Screen.Recording.2025-01-15.at.17.12.47.mov

melvin-bot · 2025-01-15T14:40:48Z

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

abdulrahuman5196 · 2025-01-15T16:43:26Z

@mkzie2 Link checks are failing. Kindly fix those.

mkzie2 · 2025-01-16T05:41:05Z

@abdulrahuman5196 I fixed.

mkzie2 · 2025-01-21T03:20:01Z

@abdulrahuman5196 Friendly bump.

abdulrahuman5196 · 2025-01-21T07:57:54Z

Checking now

abdulrahuman5196

@mkzie2 Other changes looks fine. Could you kindly respond to the above questions?

abdulrahuman5196 · 2025-01-21T08:05:46Z

src/libs/actions/IOU.ts

+    const {
+        amount,
+        currency,
+        created = '',


why is created having default value? While the previous didn't have default one?

The reason is other places we're passing the created like this then that will cause the lint to fail and the code isn't cleaner. So I updated the created with the default value '' then we can remove ?? ''.

transaction?.created ?? '',

src/pages/iou/request/step/IOURequestStepAmount.tsx

mkzie2 · 2025-01-23T02:24:13Z

@abdulrahuman5196 Any update here?

abdulrahuman5196 · 2025-01-27T10:44:14Z

@mkzie2 Code looks good. Could you fix the merge conflicts and then I can work on platform testing videos?

mkzie2 · 2025-01-27T16:10:47Z

@abdulrahuman5196 I fixed, please help to check again.

mkzie2 · 2025-02-03T04:59:33Z

@abdulrahuman5196 Friendly bump.

abdulrahuman5196 · 2025-02-03T14:33:06Z

Hi, @neil-marcellini I would be unavailable for couple of days. Could you kindly add the appropriate labels for another random C+ to take over? Unassigning myself to avoid delays.

dukenv0307 · 2025-02-04T07:52:55Z

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.2025-02-04.at.14.48.12.mov

Android: mWeb Chrome

Screen.Recording.2025-02-04.at.14.46.47.mov

iOS: Native

Screen.Recording.2025-02-04.at.14.48.47.mov

iOS: mWeb Safari

Screen.Recording.2025-02-04.at.14.43.03.mov

MacOS: Chrome / Safari

Screen.Recording.2025-02-04.at.14.41.21.mov

MacOS: Desktop

Screen.Recording.2025-02-04.at.14.52.38.mov

dukenv0307

LGTM

neil-marcellini

Overall looks great, just one small request.

src/libs/actions/IOU.ts

neil-marcellini

Cool thanks

OSBotify · 2025-02-05T18:14:11Z

✋ 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 · 2025-02-06T22:01:01Z

🚀 Deployed to staging by https://github.com/neil-marcellini in version: 9.0.95-0 🚀

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

github-actions · 2025-02-11T02:12:20Z

🚀 Deployed to production by https://github.com/Julesssss in version: 9.0.95-6 🚀

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

mkzie2 added 3 commits January 15, 2025 17:07

refactor TrackExpense function

570156f

Merge branch 'main' into mkzie2-issue/55230

922ae45

update all trackExpense function

738ab3e

mkzie2 marked this pull request as ready for review January 15, 2025 14:40

mkzie2 requested a review from a team as a code owner January 15, 2025 14:40

melvin-bot bot requested review from abdulrahuman5196 and removed request for a team January 15, 2025 14:40

mkzie2 mentioned this pull request Jan 15, 2025

[Due for payment 2025-02-18] [$250] Refactor trackExpense to use a parameter object #55230

Closed

mkzie2 added 2 commits January 16, 2025 11:53

Merge branch 'main' into mkzie2-issue/55230

67fe363

fix lint

c3bd9f1

merge main

b4bf62d

abdulrahuman5196 reviewed Jan 21, 2025

View reviewed changes

merge main

18fd543

merge main

30c3581

neil-marcellini requested review from dukenv0307 and abdulrahuman5196 and removed request for abdulrahuman5196 February 3, 2025 22:35

Merge branch 'main' into mkzie2-issue/55230

c2096d4

dukenv0307 approved these changes Feb 4, 2025

View reviewed changes

melvin-bot bot requested a review from neil-marcellini February 4, 2025 07:53

neil-marcellini requested changes Feb 4, 2025

View reviewed changes

src/libs/actions/IOU.ts Outdated Show resolved Hide resolved

mkzie2 added 2 commits February 5, 2025 22:28

Merge branch 'main' into mkzie2-issue/55230

ff4079a

make merchant and comment as optional

fb818ef

neil-marcellini approved these changes Feb 5, 2025

View reviewed changes

neil-marcellini merged commit 1a7e1ed into Expensify:main Feb 5, 2025
17 checks passed

github-actions bot mentioned this pull request Feb 6, 2025

Deploy Checklist: New Expensify 2025-02-06 #56482

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactor TrackExpense function #55261

Refactor TrackExpense function #55261

mkzie2 commented Jan 15, 2025

melvin-bot bot commented Jan 15, 2025

abdulrahuman5196 commented Jan 15, 2025

mkzie2 commented Jan 16, 2025

mkzie2 commented Jan 21, 2025

abdulrahuman5196 commented Jan 21, 2025

abdulrahuman5196 left a comment

abdulrahuman5196 Jan 21, 2025

mkzie2 Jan 21, 2025

mkzie2 commented Jan 23, 2025

abdulrahuman5196 commented Jan 27, 2025

mkzie2 commented Jan 27, 2025

mkzie2 commented Feb 3, 2025

abdulrahuman5196 commented Feb 3, 2025

dukenv0307 commented Feb 4, 2025

dukenv0307 left a comment

neil-marcellini left a comment

neil-marcellini left a comment

OSBotify commented Feb 5, 2025

github-actions bot commented Feb 6, 2025

github-actions bot commented Feb 11, 2025

Refactor TrackExpense function #55261

Refactor TrackExpense function #55261

Conversation

mkzie2 commented Jan 15, 2025

Explanation of Change

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Jan 15, 2025

abdulrahuman5196 commented Jan 15, 2025

mkzie2 commented Jan 16, 2025

mkzie2 commented Jan 21, 2025

abdulrahuman5196 commented Jan 21, 2025

abdulrahuman5196 left a comment

Choose a reason for hiding this comment

abdulrahuman5196 Jan 21, 2025

Choose a reason for hiding this comment

mkzie2 Jan 21, 2025

Choose a reason for hiding this comment

mkzie2 commented Jan 23, 2025

abdulrahuman5196 commented Jan 27, 2025

mkzie2 commented Jan 27, 2025

mkzie2 commented Feb 3, 2025

abdulrahuman5196 commented Feb 3, 2025

dukenv0307 commented Feb 4, 2025

Reviewer Checklist

Screenshots/Videos

dukenv0307 left a comment

Choose a reason for hiding this comment

neil-marcellini left a comment

Choose a reason for hiding this comment

neil-marcellini left a comment

Choose a reason for hiding this comment

OSBotify commented Feb 5, 2025

github-actions bot commented Feb 6, 2025

github-actions bot commented Feb 11, 2025