[$250] [GPS]Transactions - Always use `iouRequestType` to check for request type

[GCyganek]

Currently we have is{Type}Request utils for every request type here which:

1. Check for iouRequestType during the expense creation flow before the transaction has been saved to the server
2. When the transaction object is returned from the server after it has been created, checks for different transaction fields specific to the checked request type, since iouRequestType was not being returned from the server for transactions.

The second case has started to be a problem because we were not able to easily distinguish a map request from a GPS request, as their server transaction objects have no differences, and we were forced to use a temporary hack to make the utils work properly for these request types.

This has changed with this backend change where we started sending iouRequestType from the server for all transactions. Because of that, we can simplify the is{Type}Request() utils to only check for iouRequestType in both cases.

Example:

function isPerDiemRequest(transaction: OnyxEntry<Transaction>): boolean {
    // This is used during the expense creation flow before the transaction has been saved to the server
    if (transaction && Object.hasOwn(transaction, 'iouRequestType')) {
        return transaction?.iouRequestType === CONST.IOU.REQUEST_TYPE.PER_DIEM;
    }

    // This is the case for transaction objects once they have been saved to the server
    const type = transaction?.comment?.type;
    const customUnitName = transaction?.comment?.customUnit?.name;
    return type === CONST.TRANSACTION.TYPE.CUSTOM_UNIT && customUnitName === CONST.CUSTOM_UNITS.NAME_PER_DIEM_INTERNATIONAL;
}

Can be simplified to this:

function isPerDiemRequest(transaction: OnyxEntry<Transaction>): boolean {
    if (!transaction || !Object.hasOwn(transaction, 'iouRequestType')) {
        return false;
    }

    return transaction.iouRequestType === CONST.IOU.REQUEST_TYPE.PER_DIEM;
}

Issue Owner

Current Issue Owner: @mananjadhav

Upwork Automation - Do Not Edit

• Upwork Job URL: https://www.upwork.com/jobs/~022040116440968488926
• Upwork Job ID: 2040116440968488926
• Last Price Increase: 2026-04-10

[GCyganek]

cc: @AndrewGable @jnowakow

[melvin-bot]

📣 @SIMalik! 📣
Hey, it seems we don’t have your contributor details yet! You'll only have to do this once, and this is how we'll hire you on Upwork.
Please follow these steps:

1. Make sure you've read and understood the contributing guidelines.
2. Get the email address used to login to your Expensify account. If you don't already have an Expensify account, create one here. If you have multiple accounts (e.g. one for testing), please use your main account email.
3. Get the link to your Upwork profile. It's necessary because we only pay via Upwork. You can access it by logging in, and then clicking on your name. It'll look like this. If you don't already have an account, sign up for one here.
4. Copy the format below and paste it in a comment on this issue. Replace the placeholder text with your actual details.
   
   Format:

Contributor details
Your Expensify account email: <REPLACE EMAIL HERE>
Upwork Profile Link: <REPLACE LINK HERE>

[mobile84developer-ctrl]

Proposal

Please re-state the problem that we are trying to solve in this issue.

We have inconsistent is{Type}Request utility functions that use two different methods to determine transaction types:

During expense creation (before server save): Check iouRequestType field

After server save: Check various transaction fields (comment type, custom unit name, waypoints, etc.)

This dual-check approach is problematic because:

It adds unnecessary complexity

Some request types (map vs GPS) couldn't be distinguished from server transactions

A temporary hack with keyForList was needed for GPS requests

With a recent backend change, iouRequestType is now returned from the server for all transactions

What is the root cause of that problem?

The utilities were written when iouRequestType wasn't returned from the server, forcing them to use different field combinations to identify transaction types. Now that the backend sends iouRequestType for all transactions, we can simplify these utilities to only check that field.

What changes do you think we should make in order to solve the problem?

Update all is{Type}Request utility functions to only check iouRequestType, removing the fallback logic that examines transaction fields. Also update getRequestType to use these simplified functions.

Replace the current implementation of all request type check functions:

In src/libs/TransactionUtils/index.ts

Replace

App/src/libs/TransactionUtils/index.ts

Lines 140 to 154 in 6005632

	function isDistanceRequest(transaction: OnyxEntry<Transaction>): boolean {
	// This is used during the expense creation flow before the transaction has been saved to the server
	if (transaction && Object.hasOwn(transaction, 'iouRequestType')) {
	return (
	transaction?.iouRequestType === CONST.IOU.REQUEST_TYPE.DISTANCE ||
	transaction?.iouRequestType === CONST.IOU.REQUEST_TYPE.DISTANCE_MAP ||
	transaction?.iouRequestType === CONST.IOU.REQUEST_TYPE.DISTANCE_ODOMETER ||
	transaction?.iouRequestType === CONST.IOU.REQUEST_TYPE.DISTANCE_GPS ||
	transaction?.iouRequestType === CONST.IOU.REQUEST_TYPE.DISTANCE_MANUAL
	);
	}
	// This is the case for transaction objects once they have been saved to the server
	return hasDistanceCustomUnit(transaction);
	}

with

function isDistanceRequest(transaction: OnyxEntry<Transaction>): boolean {
    if (!transaction || !Object.hasOwn(transaction, 'iouRequestType')) {
        return false;
    }
    return (
        transaction.iouRequestType === CONST.IOU.REQUEST_TYPE.DISTANCE ||
        transaction.iouRequestType === CONST.IOU.REQUEST_TYPE.DISTANCE_MAP ||
        transaction.iouRequestType === CONST.IOU.REQUEST_TYPE.DISTANCE_ODOMETER ||
        transaction.iouRequestType === CONST.IOU.REQUEST_TYPE.DISTANCE_GPS ||
        transaction.iouRequestType === CONST.IOU.REQUEST_TYPE.DISTANCE_MANUAL
    );
}

Replace

App/src/libs/TransactionUtils/index.ts

Lines 156 to 164 in 6005632

	function isDistanceTypeRequest(transaction: OnyxEntry<Transaction>): boolean {
	// This is used during the expense creation flow before the transaction has been saved to the server
	if (transaction && Object.hasOwn(transaction, 'iouRequestType')) {
	return transaction?.iouRequestType === CONST.IOU.REQUEST_TYPE.DISTANCE;
	}
	// This is the case for transaction objects once they have been saved to the server
	return hasDistanceCustomUnit(transaction);
	}

With

function isDistanceTypeRequest(transaction: OnyxEntry<Transaction>): boolean {
    if (!transaction || !Object.hasOwn(transaction, 'iouRequestType')) {
        return false;
    }
    return transaction.iouRequestType === CONST.IOU.REQUEST_TYPE.DISTANCE;
}

Replace

App/src/libs/TransactionUtils/index.ts

Lines 173 to 183 in 6005632

	function hasGPSWaypoints(transaction: OnyxEntry<Transaction>) {
	const waypoints = transaction?.comment?.waypoints;
	if (!waypoints) {
	return false;
	}
	const waypoint = Object.values(waypoints).at(0);
	return !!waypoint?.keyForList?.startsWith('gps');
	}

With

// Function removed - no longer needed

Replace

App/src/libs/TransactionUtils/index.ts

Lines 185 to 193 in 6005632

	function isMapDistanceRequest(transaction: OnyxEntry<Transaction>): boolean {
	// This is used during the expense creation flow before the transaction has been saved to the server
	if (transaction && Object.hasOwn(transaction, 'iouRequestType')) {
	return transaction?.iouRequestType === CONST.IOU.REQUEST_TYPE.DISTANCE_MAP;
	}
	// This is the case for transaction objects once they have been saved to the server
	return hasDistanceCustomUnit(transaction) && !hasGPSWaypoints(transaction);
	}

With

function isMapDistanceRequest(transaction: OnyxEntry<Transaction>): boolean {
    if (!transaction || !Object.hasOwn(transaction, 'iouRequestType')) {
        return false;
    }
    return transaction.iouRequestType === CONST.IOU.REQUEST_TYPE.DISTANCE_MAP;
}

Replace

App/src/libs/TransactionUtils/index.ts

Lines 195 to 203 in 6005632

	function isGPSDistanceRequest(transaction: OnyxEntry<Transaction>): boolean {
	// This is used during the expense creation flow before the transaction has been saved to the server
	if (transaction && Object.hasOwn(transaction, 'iouRequestType')) {
	return transaction?.iouRequestType === CONST.IOU.REQUEST_TYPE.DISTANCE_GPS;
	}
	// This is the case for transaction objects once they have been saved to the server
	return hasGPSWaypoints(transaction);
	}

With

function isGPSDistanceRequest(transaction: OnyxEntry<Transaction>): boolean {
    if (!transaction || !Object.hasOwn(transaction, 'iouRequestType')) {
        return false;
    }
    return transaction.iouRequestType === CONST.IOU.REQUEST_TYPE.DISTANCE_GPS;
}

Replace

App/src/libs/TransactionUtils/index.ts

Lines 205 to 219 in 6005632

	function isManualDistanceRequest(transaction: OnyxEntry<Transaction>, isUpdatedMergeTransaction = false): boolean {
	// This is used during the expense creation flow before the transaction has been saved to the server
	if (transaction && Object.hasOwn(transaction, 'iouRequestType') && !isUpdatedMergeTransaction) {
	return transaction?.iouRequestType === CONST.IOU.REQUEST_TYPE.DISTANCE_MANUAL;
	}
	// This is the case for transaction objects once they have been saved to the server
	// Exclude odometer requests which also have no waypoints but have odometer readings
	return (
	hasDistanceCustomUnit(transaction) &&
	isEmptyObject(transaction?.comment?.waypoints) &&
	transaction?.comment?.odometerStart === undefined &&
	transaction?.comment?.odometerEnd === undefined
	);
	}

With

function isManualDistanceRequest(transaction: OnyxEntry<Transaction>, isUpdatedMergeTransaction = false): boolean {
    if (!transaction || !Object.hasOwn(transaction, 'iouRequestType')) {
        return false;
    }
    return transaction.iouRequestType === CONST.IOU.REQUEST_TYPE.DISTANCE_MANUAL;
}

Replace

App/src/libs/TransactionUtils/index.ts

Lines 221 to 234 in 6005632

	function isOdometerDistanceRequest(transaction: OnyxEntry<Transaction>): boolean {
	// This is used during the expense creation flow before the transaction has been saved to the server
	if (transaction && Object.hasOwn(transaction, 'iouRequestType')) {
	return transaction?.iouRequestType === CONST.IOU.REQUEST_TYPE.DISTANCE_ODOMETER;
	}
	// This is the case for transaction objects once they have been saved to the server
	// Odometer requests have odometerStart and odometerEnd in comment, and no waypoints
	return (
	hasDistanceCustomUnit(transaction) &&
	isEmptyObject(transaction?.comment?.waypoints) &&
	(transaction?.comment?.odometerStart !== undefined || transaction?.comment?.odometerEnd !== undefined)
	);
	}

With

function isOdometerDistanceRequest(transaction: OnyxEntry<Transaction>): boolean {
    if (!transaction || !Object.hasOwn(transaction, 'iouRequestType')) {
        return false;
    }
    return transaction.iouRequestType === CONST.IOU.REQUEST_TYPE.DISTANCE_ODOMETER;
}

Replace

App/src/libs/TransactionUtils/index.ts

Lines 236 to 248 in 6005632

	function isScanRequest(transaction: OnyxEntry<Transaction> | Partial<Transaction>): boolean {
	// This is used during the expense creation flow before the transaction has been saved to the server
	if (transaction && Object.hasOwn(transaction, 'iouRequestType')) {
	return transaction?.iouRequestType === CONST.IOU.REQUEST_TYPE.SCAN;
	}
	// Distance requests can have a receipt source (for the map), so we need to exclude them
	if (hasDistanceCustomUnit(transaction)) {
	return false;
	}
	return !!transaction?.receipt?.source && transaction?.amount === 0;
	}

With

function isScanRequest(transaction: OnyxEntry<Transaction> | Partial<Transaction>): boolean {
    if (!transaction || !Object.hasOwn(transaction, 'iouRequestType')) {
        return false;
    }
    return transaction.iouRequestType === CONST.IOU.REQUEST_TYPE.SCAN;
}

Replace

App/src/libs/TransactionUtils/index.ts

Lines 250 to 260 in 6005632

	function isPerDiemRequest(transaction: OnyxEntry<Transaction>): boolean {
	// This is used during the expense creation flow before the transaction has been saved to the server
	if (transaction && Object.hasOwn(transaction, 'iouRequestType')) {
	return transaction?.iouRequestType === CONST.IOU.REQUEST_TYPE.PER_DIEM;
	}
	// This is the case for transaction objects once they have been saved to the server
	const type = transaction?.comment?.type;
	const customUnitName = transaction?.comment?.customUnit?.name;
	return type === CONST.TRANSACTION.TYPE.CUSTOM_UNIT && customUnitName === CONST.CUSTOM_UNITS.NAME_PER_DIEM_INTERNATIONAL;
	}

With

function isPerDiemRequest(transaction: OnyxEntry<Transaction>): boolean {
    if (!transaction || !Object.hasOwn(transaction, 'iouRequestType')) {
        return false;
    }
    return transaction.iouRequestType === CONST.IOU.REQUEST_TYPE.PER_DIEM;
}

Replace

App/src/libs/TransactionUtils/index.ts

Lines 262 to 270 in 6005632

	function isTimeRequest(transaction: OnyxEntry<Transaction>): boolean {
	// This is used during the expense creation flow before the transaction has been saved to the server
	if (transaction && Object.hasOwn(transaction, 'iouRequestType')) {
	return transaction?.iouRequestType === CONST.IOU.REQUEST_TYPE.TIME;
	}
	// This is the case for transaction objects once they have been saved to the server
	return transaction?.comment?.type === CONST.TRANSACTION.TYPE.TIME;
	}

With

function isTimeRequest(transaction: OnyxEntry<Transaction>): boolean {
    if (!transaction || !Object.hasOwn(transaction, 'iouRequestType')) {
        return false;
    }
    return transaction.iouRequestType === CONST.IOU.REQUEST_TYPE.TIME;
}

Replace

App/src/libs/TransactionUtils/index.ts

Lines 276 to 303 in 6005632

	function getRequestType(transaction: OnyxEntry<Transaction>): IOURequestType {
	if (isOdometerDistanceRequest(transaction)) {
	return CONST.IOU.REQUEST_TYPE.DISTANCE_ODOMETER;
	}
	if (isManualDistanceRequest(transaction)) {
	return CONST.IOU.REQUEST_TYPE.DISTANCE_MANUAL;
	}
	if (isMapDistanceRequest(transaction)) {
	return CONST.IOU.REQUEST_TYPE.DISTANCE_MAP;
	}
	if (isDistanceTypeRequest(transaction)) {
	return CONST.IOU.REQUEST_TYPE.DISTANCE;
	}
	if (isScanRequest(transaction)) {
	return CONST.IOU.REQUEST_TYPE.SCAN;
	}
	if (isPerDiemRequest(transaction)) {
	return CONST.IOU.REQUEST_TYPE.PER_DIEM;
	}
	if (isTimeRequest(transaction)) {
	return CONST.IOU.REQUEST_TYPE.TIME;
	}
	if (isGPSDistanceRequest(transaction)) {
	return CONST.IOU.REQUEST_TYPE.DISTANCE_GPS;
	}
	return CONST.IOU.REQUEST_TYPE.MANUAL;
	}

With

function getRequestType(transaction: OnyxEntry<Transaction>): IOURequestType {
    if (!transaction || !Object.hasOwn(transaction, 'iouRequestType')) {
        return CONST.IOU.REQUEST_TYPE.MANUAL;
    }
    return transaction.iouRequestType;
}

Replace

App/src/libs/TransactionUtils/index.ts

Lines 383 to 390 in 6005632

	function isManualRequest(transaction: Transaction): boolean {
	// This is used during the expense creation flow before the transaction has been saved to the server
	if (transaction && Object.hasOwn(transaction, 'iouRequestType')) {
	return transaction.iouRequestType === CONST.IOU.REQUEST_TYPE.MANUAL;
	}
	return getRequestType(transaction) === CONST.IOU.REQUEST_TYPE.MANUAL;
	}

With

function isManualRequest(transaction: Transaction): boolean {
    if (!transaction || !Object.hasOwn(transaction, 'iouRequestType')) {
        return false;
    }
    return transaction.iouRequestType === CONST.IOU.REQUEST_TYPE.MANUAL;
}

What alternative solutions did you explore? (Optional)

N/A

[melvin-bot]

12 days overdue. Walking. Toward. The. Light...

[melvin-bot]

This issue has not been updated in over 14 days. eroding to Weekly issue.

[GCyganek]

I'll take care of this tomorrow