refactor: add BaseTransactionParams. #57635

Krishna2323 · 2025-02-28T23:36:37Z

Explanation of Change

Fixed Issues

$ #57257
PROPOSAL: #57257 (comment)

Tests

Press FAB > Create Expense
Enter Amount and confirm
Verify that the expense is created successfully
Create a Track expense, Per Diem expense and a split transaction
Verify all the transactions are created successfully

Verify that no errors appear in the JS console

Offline tests

Press FAB > Create Expense
Enter Amount and confirm
Verify that the expense is created successfully
Create a Track expense, Per Diem expense and a split transaction
Verify all the transactions are created successfully

QA Steps

Press FAB > Create Expense
Enter Amount and confirm
Verify that the expense is created successfully
Create a Track expense, Per Diem expense and a split transaction
Verify all the transactions are created successfully

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-28T23:36:42Z

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

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

paultsimura · 2025-03-01T11:18:58Z

src/libs/actions/IOU.ts

    iouRequestType?: IOURequestType;
-    taxCode?: string;
-    taxAmount?: number;
+    comment: string;


The BaseTransactionParams already includes comment: string; - no need to omit it and add again.
Also, in BaseTransactionParams, customUnitRateID is optional. We probably can go without omitting it either. But would like to hear @neil-marcellini's opinion on this.

@neil-marcellini thoughts?

I don't feel too strongly about this, but if customUnitRateID isn't used then I think it's more clear to omit it to make it clear that the function never needs it.

We should fix this though

The BaseTransactionParams already includes comment: string; - no need to omit it and add again.

paultsimura · 2025-03-01T11:20:07Z

src/libs/actions/IOU.ts

-    currency: string;
-    merchant: string;
-    billable?: boolean;
+type DistanceRequestTransactionParams = Omit<BaseTransactionParams, 'comment'> & {


Suggested change

type DistanceRequestTransactionParams = Omit<BaseTransactionParams, 'comment'> & {

type DistanceRequestTransactionParams = BaseTransactionParams & {

paultsimura · 2025-03-01T11:20:14Z

src/libs/actions/IOU.ts

    splitShares?: SplitShares;
+    comment: string;


Suggested change

comment: string;

paultsimura · 2025-03-01T11:24:40Z

src/libs/actions/IOU.ts

    taxCode: string;
    taxAmount: number;


I've checked the call chain - we can make these 2 optional as well (reuse from BaseTransactionParams) and remove fallback of these 2 fields in all paces where it's called, e.g.:

App/src/libs/actions/IOU.ts

Lines 4837 to 4838 in 042ec4d

taxCode = '',

taxAmount = 0,

ESLint will throw errors, taxCode & taxAmount are required value in many places. e.g.:

App/src/libs/API/parameters/CategorizeTrackedExpenseParams.ts

Lines 3 to 33 in c5bba74

type CategorizeTrackedExpenseParams = {

amount: number;

currency: string;

comment: string;

created: string;

merchant: string;

policyID: string | undefined;

transactionID: string | undefined;

moneyRequestPreviewReportActionID: string | undefined;

moneyRequestReportID: string | undefined;

moneyRequestCreatedReportActionID: string | undefined;

actionableWhisperReportActionID: string | undefined;

modifiedExpenseReportActionID: string;

reportPreviewReportActionID: string | undefined;

category?: string;

tag?: string;

receipt?: Receipt;

taxCode: string;

taxAmount: number;

billable?: boolean;

waypoints?: string;

customUnitRateID?: string;

policyExpenseChatReportID?: string;

policyExpenseCreatedReportActionID?: string;

adminsChatReportID?: string;

adminsCreatedReportActionID?: string;

guidedSetupData?: string;

engagementChoice?: string;

};

export default CategorizeTrackedExpenseParams;

paultsimura · 2025-03-05T14:39:54Z

@Krishna2323 please fix the rest of the comments in the mentime.

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

paultsimura · 2025-03-09T16:11:55Z

Thanks, reviewing now.

@Krishna2323 please fill in the checklist when you have a chance.

Krishna2323 · 2025-03-10T06:19:25Z

@paultsimura checklist completed.

paultsimura · 2025-03-11T11:13: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

417694865-532d4c6a-4d52-4dcc-bc8e-f231a1a12f58.webm

Android: mWeb Chrome

417695756-21470f2a-c44b-4988-a107-559558f4d46e.webm

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

Screen.Recording.2025-03-11.at.12.05.51.mov

MacOS: Desktop

Screen.Recording.2025-03-11.at.12.11.28.mov

paultsimura

LGTM ✔️

neil-marcellini

I'd like to see some small changes to ensure it's logically equivalent to what's on main and to remove some redundancies.

src/libs/actions/IOU.ts

neil-marcellini · 2025-03-11T17:41:28Z

src/libs/actions/IOU.ts

 };

-type PerDiemExpenseTransactionParams = {
-    currency: string;
-    comment?: string;


Comment was optional and now it's required. Can we please undo that by omitting it and then adding it as explicitly optional?

neil-marcellini · 2025-03-11T17:44:20Z

src/libs/actions/IOU.ts

    iouRequestType?: IOURequestType;
-    taxCode?: string;
-    taxAmount?: number;
+    comment: string;


We should fix this though

The BaseTransactionParams already includes comment: string; - no need to omit it and add again.

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

neil-marcellini

Cool thanks

OSBotify · 2025-03-12T18:03:02Z

✋ 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-03-14T02:17:46Z

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

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

github-actions · 2025-03-17T11:40:14Z

🚀 Deployed to production by https://github.com/mountiny in version: 9.1.13-5 🚀

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

refactor: add BaseTransactionParams.

8c41be9

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

Krishna2323 requested a review from a team as a code owner February 28, 2025 23:36

melvin-bot bot requested review from paultsimura and removed request for a team February 28, 2025 23:36

Krishna2323 mentioned this pull request Feb 28, 2025

refactor: createSplitsAndOnyxData to use a parameter object. #57295

Merged

49 tasks

Krishna2323 added 2 commits March 1, 2025 05:17

fix ts.

9e762d9

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

fix: typecheck issues.

042ec4d

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

paultsimura suggested changes Mar 1, 2025

View reviewed changes

Krishna2323 added 2 commits March 6, 2025 07:23

Merge branch 'Expensify:main' into krishna2323/issue/57257_pt2

5d0b6e2

minor fix.

2bb6000

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

Merge branch 'Expensify:main' into krishna2323/issue/57257_pt2

e136dcc

paultsimura approved these changes Mar 11, 2025

View reviewed changes

neil-marcellini requested changes Mar 11, 2025

View reviewed changes

minor fixes.

25e964c

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

neil-marcellini approved these changes Mar 12, 2025

View reviewed changes

neil-marcellini merged commit eaf171e into Expensify:main Mar 12, 2025
18 checks passed

Krishna2323 mentioned this pull request Mar 12, 2025

[Due for payment 2025-03-24] [Due for payment 2025-03-11] [$125] Refactor createSplitsAndOnyxData to use a parameter object #57257

Closed

github-actions bot mentioned this pull request Mar 14, 2025

Deploy Checklist: New Expensify 2025-03-14 #58424

Closed

90 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor: add BaseTransactionParams. #57635

refactor: add BaseTransactionParams. #57635

Krishna2323 commented Feb 28, 2025 •

edited

Loading

melvin-bot bot commented Feb 28, 2025

paultsimura Mar 1, 2025

Krishna2323 Mar 4, 2025

neil-marcellini Mar 7, 2025

neil-marcellini Mar 11, 2025

paultsimura Mar 1, 2025

paultsimura Mar 1, 2025

paultsimura Mar 1, 2025

Krishna2323 Mar 6, 2025

paultsimura commented Mar 5, 2025

paultsimura commented Mar 9, 2025

Krishna2323 commented Mar 10, 2025

paultsimura commented Mar 11, 2025

paultsimura left a comment

neil-marcellini left a comment

neil-marcellini Mar 11, 2025

Krishna2323 Mar 11, 2025

neil-marcellini Mar 11, 2025

neil-marcellini left a comment

OSBotify commented Mar 12, 2025

github-actions bot commented Mar 14, 2025

github-actions bot commented Mar 17, 2025

	type DistanceRequestTransactionParams = Omit<BaseTransactionParams, 'comment'> & {
	type DistanceRequestTransactionParams = BaseTransactionParams & {

	type CategorizeTrackedExpenseParams = {
	amount: number;
	currency: string;
	comment: string;
	created: string;
	merchant: string;
	policyID: string \| undefined;
	transactionID: string \| undefined;
	moneyRequestPreviewReportActionID: string \| undefined;
	moneyRequestReportID: string \| undefined;
	moneyRequestCreatedReportActionID: string \| undefined;
	actionableWhisperReportActionID: string \| undefined;
	modifiedExpenseReportActionID: string;
	reportPreviewReportActionID: string \| undefined;
	category?: string;
	tag?: string;
	receipt?: Receipt;
	taxCode: string;
	taxAmount: number;
	billable?: boolean;
	waypoints?: string;
	customUnitRateID?: string;
	policyExpenseChatReportID?: string;
	policyExpenseCreatedReportActionID?: string;
	adminsChatReportID?: string;
	adminsCreatedReportActionID?: string;
	guidedSetupData?: string;
	engagementChoice?: string;
	};

	export default CategorizeTrackedExpenseParams;

refactor: add BaseTransactionParams. #57635

refactor: add BaseTransactionParams. #57635

Conversation

Krishna2323 commented Feb 28, 2025 • edited Loading

Explanation of Change

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Feb 28, 2025

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

paultsimura commented Mar 5, 2025

paultsimura commented Mar 9, 2025

Krishna2323 commented Mar 10, 2025

paultsimura commented Mar 11, 2025

Reviewer Checklist

Screenshots/Videos

paultsimura left a comment

Choose a reason for hiding this comment

neil-marcellini left a 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

neil-marcellini left a comment

Choose a reason for hiding this comment

OSBotify commented Mar 12, 2025

github-actions bot commented Mar 14, 2025

github-actions bot commented Mar 17, 2025

Krishna2323 commented Feb 28, 2025 •

edited

Loading