Skip to content

Commit

Permalink
Merge pull request #55261 from mkzie2/mkzie2-issue/55230
Browse files Browse the repository at this point in the history 
Refactor TrackExpense function
  • Loading branch information
@neil-marcellini
neil-marcellini authored Feb 5, 2025
2 parents eeca391 + fb818ef commit 1a7e1ed
Show file tree
Hide file tree
Showing 8 changed files with 291 additions and 283 deletions.
81 changes: 53 additions & 28 deletions src/libs/actions/IOU.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -448,6 +448,35 @@ type CreateDistanceRequestInformation = {
policyParams?: RequestMoneyPolicyParams;
};

type TrackExpenseTransactionParams = {
amount: number;
currency: string;
created: string | undefined;
merchant?: string;
comment?: string;
receipt?: Receipt;
category?: string;
tag?: string;
taxCode?: string;
taxAmount?: number;
billable?: boolean;
validWaypoints?: WaypointCollection;
gpsPoints?: GPSPoint;
actionableWhisperReportActionID?: string;
linkedTrackedExpenseReportAction?: OnyxTypes.ReportAction;
linkedTrackedExpenseReportID?: string;
customUnitRateID?: string;
};

type CreateTrackExpenseParams = {
report: OnyxTypes.Report;
isDraftPolicy: boolean;
action?: IOUAction;
participantParams: RequestMoneyParticipantParams;
policyParams?: RequestMoneyPolicyParams;
transactionParams: TrackExpenseTransactionParams;
};

let allPersonalDetails: OnyxTypes.PersonalDetailsList = {};
Onyx.connect({
key: ONYXKEYS.PERSONAL_DETAILS_LIST,
Expand Down Expand Up @@ -4651,34 +4680,30 @@ function sendInvoice(
/**
* Track an expense
*/
function trackExpense(
report: OnyxTypes.Report,
amount: number,
currency: string,
created: string,
merchant: string,
payeeEmail: string | undefined,
payeeAccountID: number,
participant: Participant,
comment: string,
isDraftPolicy: boolean,
receipt?: Receipt,
category?: string,
tag?: string,
taxCode = '',
taxAmount = 0,
billable?: boolean,
policy?: OnyxEntry<OnyxTypes.Policy>,
policyTagList?: OnyxEntry<OnyxTypes.PolicyTagLists>,
policyCategories?: OnyxEntry<OnyxTypes.PolicyCategories>,
gpsPoints?: GPSPoint,
validWaypoints?: WaypointCollection,
action?: IOUAction,
actionableWhisperReportActionID?: string,
linkedTrackedExpenseReportAction?: OnyxTypes.ReportAction,
linkedTrackedExpenseReportID?: string,
customUnitRateID?: string,
) {
function trackExpense(params: CreateTrackExpenseParams) {
const {report, action, isDraftPolicy, participantParams, policyParams: policyData = {}, transactionParams: transactionData} = params;
const {participant, payeeAccountID, payeeEmail} = participantParams;
const {policy, policyCategories, policyTagList} = policyData;
const {
amount,
currency,
created = '',
merchant = '',
comment = '',
receipt,
category,
tag,
taxCode = '',
taxAmount = 0,
billable,
gpsPoints,
validWaypoints,
actionableWhisperReportActionID,
linkedTrackedExpenseReportAction,
linkedTrackedExpenseReportID,
customUnitRateID,
} = transactionData;

const isMoneyRequestReport = isMoneyRequestReportReportUtils(report);
const currentChatReport = isMoneyRequestReport ? getReportOrDraftReport(report.chatReportID) : report;
const moneyRequestReportID = isMoneyRequestReport ? report.reportID : '';
Expand Down
29 changes: 16 additions & 13 deletions src/pages/iou/request/step/IOURequestStepAmount.tsx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ import CONST from '@src/CONST';
import ONYXKEYS from '@src/ONYXKEYS';
import ROUTES from '@src/ROUTES';
import type SCREENS from '@src/SCREENS';
import type * as OnyxTypes from '@src/types/onyx';
import type {PaymentMethodType} from '@src/types/onyx/OriginalMessage';
import type Transaction from '@src/types/onyx/Transaction';
import {isEmptyObject} from '@src/types/utils/EmptyObject';
import StepScreenWrapper from './StepScreenWrapper';
import withFullTransactionOrNotFound from './withFullTransactionOrNotFound';
Expand All @@ -47,7 +47,7 @@ type AmountParams = {
type IOURequestStepAmountProps = WithCurrentUserPersonalDetailsProps &
WithWritableReportOrNotFoundProps<typeof SCREENS.MONEY_REQUEST.STEP_AMOUNT | typeof SCREENS.MONEY_REQUEST.CREATE> & {
/** The transaction object being modified in Onyx */
transaction: OnyxEntry<OnyxTypes.Transaction>;
transaction: OnyxEntry<Transaction>;

/** Whether the user input should be kept or not */
shouldKeepUserInput?: boolean;
Expand Down Expand Up @@ -219,18 +219,21 @@ function IOURequestStepAmount({
}
if (iouType === CONST.IOU.TYPE.TRACK) {
playSound(SOUNDS.DONE);
trackExpense(
trackExpense({
report,
backendAmount,
currency ?? 'USD',
transaction?.created ?? '',
CONST.TRANSACTION.PARTIAL_TRANSACTION_MERCHANT,
currentUserPersonalDetails.login,
currentUserPersonalDetails.accountID,
participants.at(0) ?? {},
'',
false,
);
isDraftPolicy: false,
participantParams: {
payeeEmail: currentUserPersonalDetails.login,
payeeAccountID: currentUserPersonalDetails.accountID,
participant: participants.at(0) ?? {},
},
transactionParams: {
amount: backendAmount,
currency: currency ?? 'USD',
created: transaction?.created,
merchant: CONST.TRANSACTION.PARTIAL_TRANSACTION_MERCHANT,
},
});
return;
}
}
Expand Down
56 changes: 31 additions & 25 deletions src/pages/iou/request/step/IOURequestStepConfirmation.tsx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -341,34 +341,40 @@ function IOURequestStepConfirmation({
if (!participant) {
return;
}
trackExpenseIOUActions(
trackExpenseIOUActions({
report,
transaction.amount,
transaction.currency,
transaction.created,
transaction.merchant,
currentUserPersonalDetails.login,
currentUserPersonalDetails.accountID,
participant,
trimmedComment,
isDraftPolicy,
receiptObj,
transaction.category,
transaction.tag,
transactionTaxCode,
transactionTaxAmount,
transaction.billable,
policy,
policyTags,
policyCategories,
gpsPoints,
Object.keys(transaction?.comment?.waypoints ?? {}).length ? getValidWaypoints(transaction.comment?.waypoints, true) : undefined,
action,
transaction.actionableWhisperReportActionID,
transaction.linkedTrackedExpenseReportAction,
transaction.linkedTrackedExpenseReportID,
customUnitRateID,
);
participantParams: {
payeeEmail: currentUserPersonalDetails.login,
payeeAccountID: currentUserPersonalDetails.accountID,
participant,
},
policyParams: {
policy,
policyCategories,
policyTagList: policyTags,
},
transactionParams: {
amount: transaction.amount,
currency: transaction.currency,
created: transaction.created,
merchant: transaction.merchant,
comment: trimmedComment,
receipt: receiptObj,
category: transaction.category,
tag: transaction.tag,
taxCode: transactionTaxCode,
taxAmount: transactionTaxAmount,
billable: transaction.billable,
gpsPoints,
validWaypoints: Object.keys(transaction?.comment?.waypoints ?? {}).length ? getValidWaypoints(transaction.comment?.waypoints, true) : undefined,
actionableWhisperReportActionID: transaction.actionableWhisperReportActionID,
linkedTrackedExpenseReportAction: transaction.linkedTrackedExpenseReportAction,
linkedTrackedExpenseReportID: transaction.linkedTrackedExpenseReportID,
customUnitRateID,
},
});
},
[
report,
Expand Down
48 changes: 21 additions & 27 deletions src/pages/iou/request/step/IOURequestStepDistance.tsx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -320,34 +320,28 @@ function IOURequestStepDistance({
const participant = participants.at(0);
if (iouType === CONST.IOU.TYPE.TRACK && participant) {
playSound(SOUNDS.DONE);
trackExpense(
trackExpense({
report,
0,
transaction?.currency ?? 'USD',
transaction?.created ?? '',
translate('iou.fieldPending'),
currentUserPersonalDetails.login,
currentUserPersonalDetails.accountID,
participant,
'',
false,
{},
'',
'',
'',
0,
false,
policy,
undefined,
undefined,
undefined,
getValidWaypoints(waypoints, true),
undefined,
undefined,
undefined,
undefined,
customUnitRateID,
);
isDraftPolicy: false,
participantParams: {
payeeEmail: currentUserPersonalDetails.login,
payeeAccountID: currentUserPersonalDetails.accountID,
participant,
},
policyParams: {
policy,
},
transactionParams: {
amount: 0,
currency: transaction?.currency ?? 'USD',
created: transaction?.created ?? '',
merchant: translate('iou.fieldPending'),
receipt: {},
billable: false,
validWaypoints: getValidWaypoints(waypoints, true),
customUnitRateID,
},
});
return;
}

Expand Down
70 changes: 35 additions & 35 deletions src/pages/iou/request/step/IOURequestStepScan/index.native.tsx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -251,19 +251,21 @@ function IOURequestStepScan({
const createTransaction = useCallback(
(receipt: Receipt, participant: Participant) => {
if (iouType === CONST.IOU.TYPE.TRACK && report) {
trackExpense(
trackExpense({
report,
0,
transaction?.currency ?? 'USD',
transaction?.created ?? '',
'',
currentUserPersonalDetails.login,
currentUserPersonalDetails.accountID,
participant,
'',
false,
receipt,
);
isDraftPolicy: false,
participantParams: {
payeeEmail: currentUserPersonalDetails.login,
payeeAccountID: currentUserPersonalDetails.accountID,
participant,
},
transactionParams: {
amount: 0,
currency: transaction?.currency ?? 'USD',
created: transaction?.created,
receipt,
},
});
} else {
requestMoney({
report,
Expand Down Expand Up @@ -339,31 +341,29 @@ function IOURequestStepScan({
(successData) => {
playSound(SOUNDS.DONE);
if (iouType === CONST.IOU.TYPE.TRACK && report) {
trackExpense(
trackExpense({
report,
0,
transaction?.currency ?? 'USD',
transaction?.created ?? '',
'',
currentUserPersonalDetails.login,
currentUserPersonalDetails.accountID,
participant,
'',
false,
receipt,
'',
'',
'',
0,
false,
policy,
{},
{},
{
lat: successData.coords.latitude,
long: successData.coords.longitude,
isDraftPolicy: false,
participantParams: {
payeeEmail: currentUserPersonalDetails.login,
payeeAccountID: currentUserPersonalDetails.accountID,
participant,
},
);
policyParams: {
policy,
},
transactionParams: {
amount: 0,
currency: transaction?.currency ?? 'USD',
created: transaction?.created,
receipt,
billable: false,
gpsPoints: {
lat: successData.coords.latitude,
long: successData.coords.longitude,
},
},
});
} else {
requestMoney({
report,
Expand Down
Loading

0 comments on commit 1a7e1ed

Please sign in to comment.