refactor: buildOnyxDataForInvoice to use a parameter object. #57294

Krishna2323 · 2025-02-23T05:14:51Z

Explanation of Change

Fixed Issues

$ #57256
PROPOSAL: #57256 (comment)

Tests

Have a workspace with invoices enabled.

Go offline
Open FAB > Select Send invoice > Enter amount
Select a participant > Send invoice
Verify optimistic invoice is created with correct data

Verify that no errors appear in the JS console

Offline tests

Have a workspace with invoices enabled.

Go offline
Open FAB > Select Send invoice > Enter amount
Select a participant > Send invoice
Verify optimistic invoice is created with correct data

QA Steps

Have a workspace with invoices enabled.

Go offline
Open FAB > Select Send invoice > Enter amount
Select a participant > Send invoice
Verify optimistic invoice is created with correct data

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

android_native.mp4

Android: mWeb Chrome

android_chrome.mp4

iOS: Native

ios_native.mp4

iOS: mWeb Safari

ios_safari.mp4

MacOS: Chrome / Safari

web_chrome.mp4

MacOS: Desktop

desktop_app.mp4

Signed-off-by: krishna2323 <[email protected]>

melvin-bot · 2025-02-23T05:29:30Z

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

dominictb · 2025-02-23T14:42:59Z

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 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.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 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.
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 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-23.at.22.07.54.mov

Android: mWeb Chrome

Screen.Recording.2025-02-23.at.20.56.49.mov

iOS: Native

Screen.Recording.2025-02-23.at.21.24.22.mov

iOS: mWeb Safari

Screen.Recording.2025-02-23.at.20.55.19.mov

MacOS: Chrome / Safari

Screen.Recording.2025-02-23.at.20.50.48.mov

MacOS: Desktop

Screen.Recording.2025-02-23.at.21.02.11.mov

dominictb · 2025-02-23T15:02:13Z

I faced some issues while building Android App, will record soon

neil-marcellini · 2025-02-24T16:40:12Z

src/libs/actions/IOU.ts

+type BuildOnyxDataForInvoiceParams = {
+    chatReport: OnyxEntry<OnyxTypes.Report>;
+    iouReport: OnyxTypes.Report;
+    transaction: OnyxTypes.Transaction;
+    chatCreatedAction: OptimisticCreatedReportAction;
+    iouCreatedAction: OptimisticCreatedReportAction;
+    iouAction: OptimisticIOUReportAction;
+    optimisticPersonalDetailListAction: OnyxTypes.PersonalDetailsList;
+    reportPreviewAction: ReportAction;
+    optimisticPolicyRecentlyUsedCategories: string[];
+    optimisticPolicyRecentlyUsedTags: OnyxTypes.RecentlyUsedTags;
+    isNewChatReport: boolean;
+    transactionThreadReport: OptimisticChatReport;
+    transactionThreadCreatedReportAction: OptimisticCreatedReportAction | null;
+    policy?: OnyxEntry<OnyxTypes.Policy>;
+    policyTagList?: OnyxEntry<OnyxTypes.PolicyTagLists>;
+    policyCategories?: OnyxEntry<OnyxTypes.PolicyCategories>;
+    optimisticRecentlyUsedCurrencies?: string[];
+    companyName?: string;
+    companyWebsite?: string;
+};


Can we please group together all chat, iou, policy, etc, related params like we do for MoneyRequestOptimisticParams?

@dominictb, I have regrouped the params, could you please look at it once? Thanks!

…ceParams. Signed-off-by: krishna2323 <[email protected]>

dominictb · 2025-02-25T03:35:19Z

src/libs/actions/IOU.ts

+        transactionThreadReport: OptimisticChatReport;
+        transactionThreadCreatedReportAction: OptimisticCreatedReportAction | null;
+    };
+    policyParams: {


I think we should use RequestMoneyPolicyParams for policyParams and create new type for optimisticData

dominictb · 2025-02-25T03:37:55Z

@Krishna2323 Almost done, I left 1 minor comment only

Signed-off-by: krishna2323 <[email protected]>

neil-marcellini · 2025-02-25T18:57:19Z

src/libs/actions/IOU.ts

+type BuildOnyxDataForInvoiceParams = {
+    chat: {
+        chatReport: OnyxEntry<OnyxTypes.Report>;
+        chatCreatedAction: OptimisticCreatedReportAction;
+        reportPreviewAction: ReportAction;
+        isNewChatReport: boolean;
+    };
+    iou: {
+        iouCreatedAction: OptimisticCreatedReportAction;
+        iouAction: OptimisticIOUReportAction;
+        iouReport: OnyxTypes.Report;
+    };
+    transactionParams: {
+        transaction: OnyxTypes.Transaction;
+        transactionThreadReport: OptimisticChatReport;
+        transactionThreadCreatedReportAction: OptimisticCreatedReportAction | null;
+    };
+    policyParams: RequestMoneyPolicyParams;
+    optimisticData: {
+        optimisticRecentlyUsedCurrencies?: string[];
+        optimisticPolicyRecentlyUsedCategories: string[];
+        optimisticPolicyRecentlyUsedTags: OnyxTypes.RecentlyUsedTags;
+        optimisticPersonalDetailListAction: OnyxTypes.PersonalDetailsList;
+    };
+    companyName?: string;
+    companyWebsite?: string;
+};


Looks good, but please remove the redundant prefixes in the sub-objects. It's redundant to have to write iou.iouSomeFieldName. For example, like we have here

App/src/libs/actions/IOU.ts

Lines 399 to 403 in 78a4032

iou: {

report: OnyxTypes.Report;

createdAction: OptimisticCreatedReportAction;

action: OptimisticIOUReportAction;

};

@neil-marcellini, I removed the prefixes, but what’s the correct way to access the nested value? Should we use iou.iouCreatedAction.reportActionID, or destructuring is preferred?

I have implemented it using destructuring. Could you please confirm if this is correct? Thanks!

const { chat: {report: chatReport, createdAction: chatCreatedAction, reportPreviewAction, isNewReport: isNewChatReport}, iou: {createdAction: iouCreatedAction, action: iouAction, report: iouReport}, transactionParams: {transaction, threadReport: transactionThreadReport, threadCreatedReportAction: transactionThreadCreatedReportAction}, policyParams: {policy, policyTagList, policyCategories}, optimisticData: { policyRecentlyUsedCategories: optimisticPolicyRecentlyUsedCategories, policyRecentlyUsedTags: optimisticPolicyRecentlyUsedTags, personalDetailListAction: optimisticPersonalDetailListAction, recentlyUsedCurrencies: optimisticRecentlyUsedCurrencies, }, companyName, companyWebsite, } = invoiceParams;

I think I prefer doing it without de-structuring iou.createdAction.reportActionID because then it's less redundant. However, I have allowed it with de-structuring before and it does have the advantage that you don't have to update all the places these variables are used.

If you would please update it to use dot notation I would appreciate that and I think it sets a good standard moving forward. Part of the goal of this refactor is to reduce the large number of variables to manage, and have a small number of object variables that are well organized and documented by their types.

Signed-off-by: krishna2323 <[email protected]>

neil-marcellini

Thanks for the update. It looks good as is, but there are conflicts. So while you resolve those please also update it to use dot notation to access param fields. Thanks for sticking with this one.

neil-marcellini · 2025-02-26T18:14:35Z

Please DM me when you get it updated and I can review quickly if I'm online

Signed-off-by: krishna2323 <[email protected]>

…iceParams. Signed-off-by: krishna2323 <[email protected]>

Signed-off-by: krishna2323 <[email protected]>

neil-marcellini

Great, thank you!

OSBotify · 2025-02-26T21:46:13Z

✋ 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-26T23:04:18Z

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

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

refactor: buildOnyxDataForInvoice to use a parameter object.

1c5fa7f

Signed-off-by: krishna2323 <[email protected]>

Krishna2323 marked this pull request as ready for review February 23, 2025 05:29

Krishna2323 requested a review from a team as a code owner February 23, 2025 05:29

melvin-bot bot requested a review from dominictb February 23, 2025 05:29

melvin-bot bot removed the request for review from a team February 23, 2025 05:29

Krishna2323 mentioned this pull request Feb 23, 2025

[$125] Refactor buildOnyxDataForInvoice to use a parameter object #57256

Open

dominictb approved these changes Feb 23, 2025

View reviewed changes

melvin-bot bot requested a review from neil-marcellini February 23, 2025 17:49

neil-marcellini requested changes Feb 24, 2025

View reviewed changes

group chat, iou, policy, etc, related params in BuildOnyxDataForInvoi…

14701ca

…ceParams. Signed-off-by: krishna2323 <[email protected]>

dominictb reviewed Feb 25, 2025

View reviewed changes

minor update.

be1fc3f

Signed-off-by: krishna2323 <[email protected]>

neil-marcellini requested changes Feb 25, 2025

View reviewed changes

remove redundant prefixes in the sub-objects.

e6b3fa3

Signed-off-by: krishna2323 <[email protected]>

neil-marcellini previously approved these changes Feb 26, 2025

View reviewed changes

Merge branch 'main' into krishna2323/issue/57256

2eafd12

Krishna2323 dismissed neil-marcellini’s stale review via 2eafd12 February 26, 2025 20:43

Krishna2323 added 4 commits February 27, 2025 02:33

use dot notation for accessing chat, iou, transactionParams propoerties.

c11d599

Signed-off-by: krishna2323 <[email protected]>

fix onyx value.

5067ccd

Signed-off-by: krishna2323 <[email protected]>

update buildOnyxDataForInvoice to use dot notation for accessing invo…

2680d31

…iceParams. Signed-off-by: krishna2323 <[email protected]>

fix eslint.

feb2b4b

Signed-off-by: krishna2323 <[email protected]>

neil-marcellini approved these changes Feb 26, 2025

View reviewed changes

neil-marcellini merged commit ee10ff8 into Expensify:main Feb 26, 2025
16 checks passed

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

Deploy Checklist: New Expensify 2025-02-26 #57504

Open

24 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor: buildOnyxDataForInvoice to use a parameter object. #57294

refactor: buildOnyxDataForInvoice to use a parameter object. #57294

Krishna2323 commented Feb 23, 2025 •

edited

Loading

melvin-bot bot commented Feb 23, 2025

dominictb commented Feb 23, 2025 •

edited

Loading

dominictb commented Feb 23, 2025

neil-marcellini Feb 24, 2025

Krishna2323 Feb 24, 2025

dominictb Feb 25, 2025

Krishna2323 Feb 25, 2025

dominictb commented Feb 25, 2025

neil-marcellini Feb 25, 2025 •

edited

Loading

Krishna2323 Feb 25, 2025

neil-marcellini Feb 26, 2025

neil-marcellini left a comment

neil-marcellini commented Feb 26, 2025

neil-marcellini left a comment

OSBotify commented Feb 26, 2025

github-actions bot commented Feb 26, 2025

	iou: {
	report: OnyxTypes.Report;
	createdAction: OptimisticCreatedReportAction;
	action: OptimisticIOUReportAction;
	};

refactor: buildOnyxDataForInvoice to use a parameter object. #57294

refactor: buildOnyxDataForInvoice to use a parameter object. #57294

Conversation

Krishna2323 commented Feb 23, 2025 • edited Loading

Explanation of Change

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Feb 23, 2025

dominictb commented Feb 23, 2025 • edited Loading

Reviewer Checklist

Screenshots/Videos

dominictb commented Feb 23, 2025

neil-marcellini Feb 24, 2025

Choose a reason for hiding this comment

Krishna2323 Feb 24, 2025

Choose a reason for hiding this comment

dominictb Feb 25, 2025

Choose a reason for hiding this comment

Krishna2323 Feb 25, 2025

Choose a reason for hiding this comment

dominictb commented Feb 25, 2025

neil-marcellini Feb 25, 2025 • edited Loading

Choose a reason for hiding this comment

Krishna2323 Feb 25, 2025

Choose a reason for hiding this comment

neil-marcellini Feb 26, 2025

Choose a reason for hiding this comment

neil-marcellini left a comment

Choose a reason for hiding this comment

neil-marcellini commented Feb 26, 2025

neil-marcellini left a comment

Choose a reason for hiding this comment

OSBotify commented Feb 26, 2025

github-actions bot commented Feb 26, 2025

Krishna2323 commented Feb 23, 2025 •

edited

Loading

dominictb commented Feb 23, 2025 •

edited

Loading

neil-marcellini Feb 25, 2025 •

edited

Loading