Refactor IOU.requestMoney function #52231

mkzie2 · 2024-11-08T07:07:15Z

Explanation of Change

Change the params of requestMoney function to object

Fixed Issues

#50368
PROPOSAL:

Tests

Precondition:

Create a WS and enable tag and tax features. Setting Default to billable in OD

Go to the WS or DM chat
Submit a manual request with all data is filled
Go to the transaction thread report or the combine report
Verify that the transaction is created successfully and all data is correct
Create a scan request
Verify it's created successfully and all data is correct

Verify that no errors appear in the JS console

Offline tests

Same as above

QA Steps

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

Go to the WS or DM chat
Submit a manual request with all data is filled
Go to the transaction thread report or the combine report
Verify that the transaction is created successfully and all data is correct
Create a scan request
Verify it's created successfully and all data is correct

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Screen.Recording.2024-11-08.at.13.46.42.mov

Android: mWeb Chrome

Screen.Recording.2024-11-08.at.13.53.21.mov

iOS: Native

Screen.Recording.2024-11-08.at.13.56.25.mov

iOS: mWeb Safari

Screen.Recording.2024-11-08.at.13.49.18.mp4

MacOS: Chrome / Safari

Screen.Recording.2024-11-08.at.13.42.03.mov

MacOS: Desktop

Screen.Recording.2024-11-08.at.13.59.23.mov

Screen.Recording.2024-11-08.at.14.09.25.mov

melvin-bot · 2024-11-08T07:34:18Z

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

dukenv0307 · 2024-11-08T07:47:07Z

src/libs/actions/IOU.ts

@@ -164,6 +164,37 @@ type GPSPoint = {
    long: number;
 };

+type RequestMoneyInformation = {


Why do you group many params into 2 objects: RequestMoneyInformation, RequestMoneyTransactionData? (Why not 1 or 3...?)

I split transaction data into one group and others into another one.

Thanks @mkzie2,

I understand your idea that RequestMoneyTransactionData should contain the params same as Onyx Transaction. For other params we can store in RequestMoneyInformation

I like splitting things up, but I envisioned it slightly different. How about a RequestMoneyParams type which contains all fields from RequestMoneyInformation, then within it we have transactionData: RequestMoneyTransactionData?

I'm leaning towards a Params suffix vs Data too

@neil-marcellini So we will only have one param and in this param we will have some sub param is a object like transactionData, policyData,... right?

@neil-marcellini Please help to take a look at my comment above when you have a chance.

@neil-marcellini Bump on the above.

Yes that's right

dukenv0307 · 2024-11-08T09:02:13Z

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.2024-11-08.at.15.58.53.mov

Android: mWeb Chrome

Screen.Recording.2024-11-08.at.15.54.33.mov

iOS: Native

Screen.Recording.2024-11-08.at.15.56.27.mov

iOS: mWeb Safari

Screen.Recording.2024-11-08.at.15.51.48.mov

MacOS: Chrome / Safari

Screen.Recording.2024-11-08.at.15.48.54.mov

MacOS: Desktop

Screen.Recording.2024-11-08.at.16.01.53.mov

neil-marcellini

Thanks for this! It's going well so far. I have some suggestions that I think will make it a bit cleaner. I like the idea of having one type for the params, that breaks down into sub-types for fields that naturally group together.

neil-marcellini · 2024-11-08T19:19:34Z

src/libs/actions/IOU.ts

@@ -164,6 +164,37 @@ type GPSPoint = {
    long: number;
 };

+type RequestMoneyInformation = {


I like splitting things up, but I envisioned it slightly different. How about a RequestMoneyParams type which contains all fields from RequestMoneyInformation, then within it we have transactionData: RequestMoneyTransactionData?

src/libs/actions/IOU.ts

dukenv0307 · 2024-11-18T02:38:45Z

@neil-marcellini @mkzie2 any updates here?

neil-marcellini · 2024-11-19T22:26:36Z

Waiting for @mkzie2 to update. Please get back to this in a few days or let us know when you can.

mkzie2 · 2024-11-20T03:24:59Z

@neil-marcellini I'm waiting your response here.

neil-marcellini · 2024-11-21T17:15:39Z

Ah I missed that, yes I think you have the right idea.

mkzie2 · 2024-11-21T18:04:52Z

@neil-marcellini I updated.

dukenv0307 · 2024-11-22T04:55:36Z

Reviewing again

neil-marcellini

Looks great to me now, thanks. One last naming change request. Please dm me when you get it updated and I'll approve. We should get another C+ test after that.

neil-marcellini · 2024-11-22T15:35:02Z

src/libs/actions/IOU.ts

+
+type RequestMoneyInformation = {
+    report: OnyxEntry<OnyxTypes.Report>;
+    participantData: RequestMoneyParticipantParams;


Nice I like how these types are set up now!

Sorry to be picky, but let's change this to participantParams instead to match the type name. Let's do the same for all fields with the suffix "Data". Change the suffix to "Params".

mkzie2 · 2024-11-22T16:15:49Z

@neil-marcellini I updated.

Please dm me when you get it updated and I'll approve

@dukenv0307 Please help to test this again if you're available and dm to @neil-marcellini because I'm requesting to join Expensify Slack.

dukenv0307 · 2024-11-22T16:17:50Z

@mkzie2 I will re-test your PR cc @neil-marcellini

dukenv0307 · 2024-11-22T16:38:58Z

LGTM and test well

web-resize.mp4

dukenv0307 · 2024-11-22T16:39:57Z

DMed to @neil-marcellini cc @mkzie2

neil-marcellini

Thanks for the rename and quick turn around. If you could do another similar PR that would be great! Please post on the linked issue what area you think we should refactor next and I will create a new issue to refactor that piece. Then post your proposal and we can keep moving forward.

mkzie2 · 2024-11-22T16:51:28Z

@neil-marcellini I commented here.

OSBotify · 2024-11-22T17:00:54Z

✋ 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 · 2024-11-22T20:31:18Z

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

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

mkzie2 added 3 commits November 8, 2024 13:59

refactor requestMoney function

1fd0aae

revert change

91caa85

fix test

6fc82cf

mkzie2 marked this pull request as ready for review November 8, 2024 07:34

mkzie2 requested a review from a team as a code owner November 8, 2024 07:34

melvin-bot bot requested review from dukenv0307 and removed request for a team November 8, 2024 07:34

mkzie2 mentioned this pull request Nov 8, 2024

[$250] [Tracking] Refactor functions with many parameters to use parameter objects #50368

Open

3 tasks

dukenv0307 reviewed Nov 8, 2024

View reviewed changes

dukenv0307 approved these changes Nov 8, 2024

View reviewed changes

melvin-bot bot requested a review from neil-marcellini November 8, 2024 09:02

neil-marcellini requested changes Nov 8, 2024

View reviewed changes

Merge branch 'main' into mkzie2-issue/50368

6f46d31

neil-marcellini marked this pull request as draft November 19, 2024 22:26

mkzie2 added 3 commits November 20, 2024 12:24

merge main

e1fbc35

resolve conflict

9bd88a2

remove change

b5ad2c1

mkzie2 requested a review from neil-marcellini November 21, 2024 03:28

mkzie2 added 2 commits November 22, 2024 00:18

Merge branch 'main' into mkzie2-issue/50368

04bcb99

merge param into one param

8d99484

mkzie2 marked this pull request as ready for review November 21, 2024 18:04

neil-marcellini requested changes Nov 22, 2024

View reviewed changes

mkzie2 added 2 commits November 22, 2024 22:50

Merge branch 'main' into mkzie2-issue/50368

4e737b3

rename param

d0918fe

rename transactionData

e08c53a

neil-marcellini approved these changes Nov 22, 2024

View reviewed changes

neil-marcellini merged commit 3797c31 into Expensify:main Nov 22, 2024
17 checks passed

github-actions bot mentioned this pull request Nov 22, 2024

Deploy Checklist: New Expensify 2024-11-22 #52978

Open

64 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactor IOU.requestMoney function #52231

Refactor IOU.requestMoney function #52231

mkzie2 commented Nov 8, 2024 •

edited by neil-marcellini

Loading

melvin-bot bot commented Nov 8, 2024

dukenv0307 Nov 8, 2024

mkzie2 Nov 8, 2024

dukenv0307 Nov 8, 2024

neil-marcellini Nov 8, 2024

neil-marcellini Nov 8, 2024

mkzie2 Nov 11, 2024

mkzie2 Nov 13, 2024

mkzie2 Nov 19, 2024

neil-marcellini Nov 21, 2024

dukenv0307 commented Nov 8, 2024

neil-marcellini left a comment

neil-marcellini Nov 8, 2024

dukenv0307 commented Nov 18, 2024

neil-marcellini commented Nov 19, 2024

mkzie2 commented Nov 20, 2024

neil-marcellini commented Nov 21, 2024

mkzie2 commented Nov 21, 2024

dukenv0307 commented Nov 22, 2024

neil-marcellini left a comment

neil-marcellini Nov 22, 2024

mkzie2 commented Nov 22, 2024

dukenv0307 commented Nov 22, 2024

dukenv0307 commented Nov 22, 2024

dukenv0307 commented Nov 22, 2024

neil-marcellini left a comment

mkzie2 commented Nov 22, 2024

OSBotify commented Nov 22, 2024

github-actions bot commented Nov 22, 2024

Refactor IOU.requestMoney function #52231

Refactor IOU.requestMoney function #52231

Conversation

mkzie2 commented Nov 8, 2024 • edited by neil-marcellini Loading

Explanation of Change

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Nov 8, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dukenv0307 commented Nov 8, 2024

Reviewer Checklist

Screenshots/Videos

neil-marcellini left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dukenv0307 commented Nov 18, 2024

neil-marcellini commented Nov 19, 2024

mkzie2 commented Nov 20, 2024

neil-marcellini commented Nov 21, 2024

mkzie2 commented Nov 21, 2024

dukenv0307 commented Nov 22, 2024

neil-marcellini left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mkzie2 commented Nov 22, 2024

dukenv0307 commented Nov 22, 2024

dukenv0307 commented Nov 22, 2024

dukenv0307 commented Nov 22, 2024

neil-marcellini left a comment

Choose a reason for hiding this comment

mkzie2 commented Nov 22, 2024

OSBotify commented Nov 22, 2024

github-actions bot commented Nov 22, 2024

mkzie2 commented Nov 8, 2024 •

edited by neil-marcellini

Loading