Skip to content
Merged
8 changes: 5 additions & 3 deletions src/libs/DistanceRequestUtils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ function getMileageRates(policy: OnyxInputOrEntry<Policy>, includeDisabledRates
* @returns [currency] - The currency associated with the rate.
* @returns [unit] - The unit of measurement for the distance.
*/
function getDefaultMileageRate(policy: OnyxInputOrEntry<Policy>): MileageRate | undefined {
function getDefaultMileageRate(policy: OnyxInputOrEntry<Policy>, localeCompare?: (a: string, b: string) => number): MileageRate | undefined {

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we make localeCompare required instead of optional? That should avoid anyone forgetting the param.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@arosiclair As mentioned earlier, getDefaultMileageRate is also used by other internal functions, such as getRate and getRateByCustomUnitRateID. Making localeCompare a required parameter would likely require significant changes to propagate it through all the places where these functions are used

For example, getRate is called in the getMerchant function in TransactionUtils. If the accepted approach is to get localeCompare from the useLocalize hook and pass localeCompare as a parameter, I think it would require big changes

There are also getUpdatedTransaction, isUnreportedAndHasInvalidDistanceRateTransaction, and buildOptimisticTransaction which call getRate and getUpdatedDistanceUnit in TransactionUtils

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Alright fair enough 👌

if (isEmptyObject(policy) || !policy?.customUnits) {
return undefined;
}
Expand All @@ -76,7 +76,7 @@ function getDefaultMileageRate(policy: OnyxInputOrEntry<Policy>): MileageRate |
if (!distanceUnit?.rates || !distanceUnit.attributes) {
return;
}
const mileageRates = Object.values(getMileageRates(policy));
const mileageRates = localeCompare ? Object.values(getMileageRates(policy)).sort((a, b) => localeCompare(a.name ?? '', b.name ?? '')) : Object.values(getMileageRates(policy));

const distanceRate = mileageRates.at(0) ?? ({} as MileageRate);

Expand Down Expand Up @@ -283,11 +283,13 @@ function getCustomUnitRateID({
isPolicyExpenseChat,
policy,
lastSelectedDistanceRates,
localeCompare,
}: {
reportID: string | undefined;
isPolicyExpenseChat: boolean;
policy: OnyxEntry<Policy> | undefined;
lastSelectedDistanceRates?: OnyxEntry<LastSelectedDistanceRates>;
localeCompare?: (a: string, b: string) => number;
}): string {
let customUnitRateID: string = CONST.CUSTOM_UNITS.FAKE_P2P_ID;

Expand All @@ -306,7 +308,7 @@ function getCustomUnitRateID({
if (lastSelectedDistanceRate?.enabled && lastSelectedDistanceRateID) {
customUnitRateID = lastSelectedDistanceRateID;
} else {
const defaultMileageRate = getDefaultMileageRate(policy);
const defaultMileageRate = getDefaultMileageRate(policy, localeCompare);
if (!defaultMileageRate?.customUnitRateID) {
return customUnitRateID;
}
Expand Down
4 changes: 3 additions & 1 deletion src/libs/actions/IOU.ts
Original file line number Diff line number Diff line change
Expand Up @@ -292,6 +292,7 @@ type InitMoneyRequestParams = {
parentReport: OnyxEntry<OnyxTypes.Report>;
currentDate: string | undefined;
lastSelectedDistanceRates?: OnyxEntry<OnyxTypes.LastSelectedDistanceRates>;
localeCompare?: (a: string, b: string) => number;
};

type MoneyRequestInformation = {
Expand Down Expand Up @@ -986,6 +987,7 @@ function initMoneyRequest({
parentReport,
currentDate = '',
lastSelectedDistanceRates,
localeCompare,
}: InitMoneyRequestParams) {
// Generate a brand new transactionID
// This will be fixed as part of https://github.com/Expensify/Expensify/issues/507850
Expand Down Expand Up @@ -1024,7 +1026,7 @@ function initMoneyRequest({
if (newIouRequestType === CONST.IOU.REQUEST_TYPE.DISTANCE || newIouRequestType === CONST.IOU.REQUEST_TYPE.DISTANCE_MAP || newIouRequestType === CONST.IOU.REQUEST_TYPE.DISTANCE_MANUAL) {
if (!isFromGlobalCreate) {
const isPolicyExpenseChat = isPolicyExpenseChatReportUtil(report) || isPolicyExpenseChatReportUtil(parentReport);
const customUnitRateID = DistanceRequestUtils.getCustomUnitRateID({reportID, isPolicyExpenseChat, policy, lastSelectedDistanceRates});
const customUnitRateID = DistanceRequestUtils.getCustomUnitRateID({reportID, isPolicyExpenseChat, policy, lastSelectedDistanceRates, localeCompare});
comment.customUnit = {customUnitRateID};
} else if (hasNoPolicyOtherThanPersonalType()) {
comment.customUnit = {customUnitRateID: CONST.CUSTOM_UNITS.FAKE_P2P_ID};
Expand Down
6 changes: 4 additions & 2 deletions src/pages/iou/request/DistanceRequestStartPage.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ function DistanceRequestStartPage({
defaultSelectedTab = CONST.TAB_REQUEST.DISTANCE_MAP,
}: DistanceRequestStartPageProps) {
const styles = useThemeStyles();
const {translate} = useLocalize();
const {translate, localeCompare} = useLocalize();
const [report] = useOnyx(`${ONYXKEYS.COLLECTION.REPORT}${reportID}`, {canBeMissing: true});
const [parentReport] = useOnyx(`${ONYXKEYS.COLLECTION.REPORT}${report?.parentReportID}`, {canBeMissing: true});
const policy = usePolicy(report?.policyID);
Expand Down Expand Up @@ -102,6 +102,7 @@ function DistanceRequestStartPage({
parentReport,
currentDate,
lastSelectedDistanceRates,
localeCompare,
});
// eslint-disable-next-line
}, []);
Expand All @@ -122,9 +123,10 @@ function DistanceRequestStartPage({
parentReport,
currentDate,
lastSelectedDistanceRates,
localeCompare,
});
},
[transaction?.iouRequestType, reportID, policy, isFromGlobalCreate, report, parentReport, currentDate, lastSelectedDistanceRates],
[transaction?.iouRequestType, reportID, policy, isFromGlobalCreate, report, parentReport, currentDate, lastSelectedDistanceRates, localeCompare],
);

// Clear out the temporary expense if the reportID in the URL has changed from the transaction's reportID.
Expand Down
6 changes: 4 additions & 2 deletions src/pages/iou/request/step/IOURequestStepDistanceManual.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ function IOURequestStepDistanceManual({
transaction,
currentUserPersonalDetails,
}: IOURequestStepDistanceManualProps) {
const {translate} = useLocalize();
const {translate, localeCompare} = useLocalize();
const styles = useThemeStyles();
const {isExtraSmallScreenHeight} = useResponsiveLayout();
const textInput = useRef<BaseTextInputRef | null>(null);
Expand Down Expand Up @@ -221,7 +221,7 @@ function IOURequestStepDistanceManual({
currency: transaction?.currency ?? 'USD',
merchant: translate('iou.fieldPending'),
billable: !!policy?.defaultBillable,
customUnitRateID: DistanceRequestUtils.getCustomUnitRateID({reportID: report.reportID, isPolicyExpenseChat, policy, lastSelectedDistanceRates}),
customUnitRateID: DistanceRequestUtils.getCustomUnitRateID({reportID: report.reportID, isPolicyExpenseChat, policy, lastSelectedDistanceRates, localeCompare}),
splitShares: transaction?.splitShares,
attendees: transaction?.comment?.attendees,
},
Expand Down Expand Up @@ -249,6 +249,7 @@ function IOURequestStepDistanceManual({
isPolicyExpenseChat: true,
policy: defaultExpensePolicy,
lastSelectedDistanceRates,
localeCompare,
});
const shouldAutoReport = !!defaultExpensePolicy?.autoReporting || !!personalPolicy?.autoReporting;
const transactionReportID = shouldAutoReport ? activePolicyExpenseChat?.reportID : CONST.REPORT.UNREPORTED_REPORT_ID;
Expand Down Expand Up @@ -292,6 +293,7 @@ function IOURequestStepDistanceManual({
navigateToConfirmationPage,
action,
distance,
localeCompare,
],
);

Expand Down
6 changes: 4 additions & 2 deletions src/pages/iou/request/step/IOURequestStepDistanceMap.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ function IOURequestStepDistanceMap({
}: IOURequestStepDistanceMapProps) {
const styles = useThemeStyles();
const {isOffline} = useNetwork();
const {translate} = useLocalize();
const {translate, localeCompare} = useLocalize();
const [allReports] = useOnyx(ONYXKEYS.COLLECTION.REPORT, {canBeMissing: false});
const [reportNameValuePairs] = useOnyx(`${ONYXKEYS.COLLECTION.REPORT_NAME_VALUE_PAIRS}${report?.reportID}`, {canBeMissing: true});
const [transactionBackup] = useOnyx(`${ONYXKEYS.COLLECTION.TRANSACTION_BACKUP}${transactionID}`, {canBeMissing: true});
Expand Down Expand Up @@ -365,7 +365,7 @@ function IOURequestStepDistanceMap({
billable: !!policy?.defaultBillable,
reimbursable: !!policy?.defaultReimbursable,
validWaypoints: getValidWaypoints(waypoints, true),
customUnitRateID: DistanceRequestUtils.getCustomUnitRateID({reportID: report.reportID, isPolicyExpenseChat, policy, lastSelectedDistanceRates}),
customUnitRateID: DistanceRequestUtils.getCustomUnitRateID({reportID: report.reportID, isPolicyExpenseChat, policy, lastSelectedDistanceRates, localeCompare}),
splitShares: transaction?.splitShares,
attendees: transaction?.comment?.attendees,
},
Expand Down Expand Up @@ -393,6 +393,7 @@ function IOURequestStepDistanceMap({
isPolicyExpenseChat: true,
policy: defaultExpensePolicy,
lastSelectedDistanceRates,
localeCompare,
});
const shouldAutoReport = !!defaultExpensePolicy?.autoReporting || !!personalPolicy?.autoReporting;
const transactionReportID = shouldAutoReport ? activePolicyExpenseChat?.reportID : CONST.REPORT.UNREPORTED_REPORT_ID;
Expand Down Expand Up @@ -434,6 +435,7 @@ function IOURequestStepDistanceMap({
navigateToConfirmationPage,
reportID,
lastSelectedDistanceRates,
localeCompare,
]);

const getError = () => {
Expand Down
11 changes: 7 additions & 4 deletions src/pages/iou/request/step/IOURequestStepDistanceRate.tsx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import React from 'react';
import React, {useMemo} from 'react';
import type {OnyxEntry} from 'react-native-onyx';
import SelectionList from '@components/SelectionListWithSections';
import RadioListItem from '@components/SelectionListWithSections/RadioListItem';
Expand Down Expand Up @@ -47,7 +47,7 @@ function IOURequestStepDistanceRate({
const policy: OnyxEntry<OnyxTypes.Policy> = policyReal ?? policyDraft;

const styles = useThemeStyles();
const {translate, toLocaleDigit} = useLocalize();
const {translate, toLocaleDigit, localeCompare} = useLocalize();
const isDistanceRequest = isDistanceRequestTransactionUtils(transaction);
const isPolicyExpenseChat = isReportInGroupPolicy(report);
const shouldShowTax = isTaxTrackingEnabled(isPolicyExpenseChat, policy, isDistanceRequest);
Expand All @@ -57,14 +57,17 @@ function IOURequestStepDistanceRate({
const transactionCurrency = getCurrency(transaction);

const rates = DistanceRequestUtils.getMileageRates(policy, false, currentRateID);
const sortedRates = useMemo(() => Object.values(rates).sort((a, b) => localeCompare(a.name ?? '', b.name ?? '')), [rates, localeCompare]);

const navigateBack = () => {
Navigation.goBack(backTo);
};

const sections = Object.values(rates).map((rate) => {
const sections = sortedRates.map((rate) => {
const unit = transaction?.comment?.customUnit?.customUnitRateID === rate.customUnitRateID ? DistanceRequestUtils.getDistanceUnit(transaction, rate) : rate.unit;
const isSelected = currentRateID ? currentRateID === rate.customUnitRateID : DistanceRequestUtils.getDefaultMileageRate(policy)?.customUnitRateID === rate.customUnitRateID;
const isSelected = currentRateID
? currentRateID === rate.customUnitRateID
: DistanceRequestUtils.getDefaultMileageRate(policy, localeCompare)?.customUnitRateID === rate.customUnitRateID;
const rateForDisplay = DistanceRequestUtils.getRateForDisplay(unit, rate.rate, isSelected ? transactionCurrency : rate.currency, translate, toLocaleDigit);
return {
text: rate.name ?? rateForDisplay,
Expand Down
18 changes: 15 additions & 3 deletions src/pages/iou/request/step/IOURequestStepParticipants.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ function IOURequestStepParticipants({
transaction: initialTransaction,
}: IOURequestStepParticipantsProps) {
const participants = initialTransaction?.participants;
const {translate} = useLocalize();
const {translate, localeCompare} = useLocalize();
const styles = useThemeStyles();
const isFocused = useIsFocused();
const [skipConfirmation] = useOnyx(`${ONYXKEYS.COLLECTION.SKIP_CONFIRMATION}${initialTransactionID}`, {canBeMissing: true});
Expand Down Expand Up @@ -232,7 +232,7 @@ function IOURequestStepParticipants({
if (!isMovingTransactionFromTrackExpense) {
// If not moving the transaction from track expense, select the default rate automatically.
// Otherwise, keep the original p2p rate and let the user manually change it to the one they want from the workspace.
const rateID = DistanceRequestUtils.getCustomUnitRateID({reportID: firstParticipantReportID, isPolicyExpenseChat, policy, lastSelectedDistanceRates});
const rateID = DistanceRequestUtils.getCustomUnitRateID({reportID: firstParticipantReportID, isPolicyExpenseChat, policy, lastSelectedDistanceRates, localeCompare});

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we add localeCompare in useCallback dependecy array?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, good catch
Added localeCompare to the useCallback dependency array in each component


if (transactions.length > 0) {
transactions.forEach((transaction) => {
Expand Down Expand Up @@ -268,7 +268,19 @@ function IOURequestStepParticipants({
shouldAutoReport.current = !!policy?.autoReporting || !!personalPolicy?.autoReporting;
}
},
[action, iouType, transactions, isMovingTransactionFromTrackExpense, reportID, trackExpense, allPolicies, personalPolicy, lastSelectedDistanceRates, initialTransactionID],
[
action,
iouType,
transactions,
isMovingTransactionFromTrackExpense,
reportID,
trackExpense,
allPolicies,
personalPolicy,
lastSelectedDistanceRates,
initialTransactionID,
localeCompare,
],
);

const goToNextStep = useCallback(() => {
Expand Down