Distance - Distance field does not show "Pending" after changing distance offline

[IuliiaHerets]

If you haven’t already, check out our contributing guidelines for onboarding and email [email protected] to request to join our Slack channel!

---

Version Number: v9.0.17-1
Reproducible in staging?: Y
Reproducible in production?: N
If this was caught during regression testing, add the test name, ID and link from TestRail: https://expensify.testrail.io/index.php?/tests/view/4827863
Email or phone of affected tester (no customers): [email protected]
Issue reported by: Applause Internal Team

Action Performed:

1. Go to staging.new.expensify.com
2. Go to workspace chat.
3. Create a distance expense with three waypoints.
4. Go to transaction thread.
5. Go offline.
6. Click Distance.
7. Remove one waypoint and save it.

Expected Result:

The Distance row will show "Pending".

Actual Result:

The Distance row still shows the previous distance instead of "Pending".

Workaround:

Unknown

Platforms:

Which of our officially supported platforms is this issue occurring on?

• Android: Native
• Android: mWeb Chrome
• iOS: Native
• iOS: mWeb Safari
• MacOS: Chrome / Safari
• MacOS: Desktop

Screenshots/Videos

Bug6564228_1723023574708.20240807_173718.mp4

View all open jobs on GitHub

[melvin-bot]

Triggered auto assignment to @anmurali (Bug), see https://stackoverflow.com/c/expensify/questions/14418 for more details. Please add this bug to a GH project, as outlined in the SO.

[melvin-bot]

Triggered auto assignment to @grgia (DeployBlockerCash), see https://stackoverflowteams.com/c/expensify/questions/9980/ for more details.

[github-actions]

👋 Friendly reminder that deploy blockers are time-sensitive ⏱ issues! Check out the open `StagingDeployCash` deploy checklist to see the list of PRs included in this release, then work quickly to do one of the following:

1. Identify the pull request that introduced this issue and revert it.
2. Find someone who can quickly fix the issue.
3. Fix the issue yourself.

[IuliiaHerets]

We think that this bug might be related to #wave-collect - Release 1

[trjExpensify]

Discussing with @paultsimura here.

[nyomanjyotisa]

Proposal

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

Distance field does not show "Pending" after changing distance offline

What is the root cause of that problem?

We don't show "Pending" if waypoints pendingFields is update

App/src/libs/DistanceRequestUtils.ts

Lines 164 to 167 in f9306d5

	function getDistanceForDisplay(hasRoute: boolean, distanceInMeters: number, unit: Unit | undefined, rate: number | undefined, translate: LocaleContextProps['translate']): string {
	if (!hasRoute || !rate || !unit || !distanceInMeters) {
	return translate('iou.fieldPending');
	}

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

show "Pending" if waypoints pendingFields is update

Add new param on getDistanceForDisplay called isPendingUpdate here and add it in the condition to show Pending

    if (!hasRoute || !rate || !unit || !distanceInMeters || isPendingUpdate) {
        return translate('iou.fieldPending');
    }

create new const to store if waypoints pendingFields is update here

const isPendingUpdate = getPendingFieldAction('waypoints') == CONST.RED_BRICK_ROAD_PENDING_ACTION.UPDATE

Then pass the isPendingUpdate here

const distanceToDisplay = DistanceRequestUtils.getDistanceForDisplay(hasRoute, distance, unit, rate, translate, isPendingUpdateDistance);

Might need to listen to pendingFields other then waypoints if needed
Also might need to show Pending for fields other than distance if needed,

What alternative solutions did you explore? (Optional)

[paultsimura]

I believe this is a regression from #46165 – we changed the way we calculate the distance in MoneyRequestView there.

[trjExpensify]

Thanks! Under the regression period, assigning back to @parasharrajat and @bernhardoj, though Bernhard I need you to comment please. :)

[trjExpensify]

@paultsimura confirming this is a bug only on the p2pDistanceRequests beta, so it shouldn't be a deploy blocker, right?

[paultsimura]

Confirmed that it's only visible under the p2pDistanceRequests beta.

[trjExpensify]

Thanks, demoting. @bernhardoj please follow up and fix this!

[bernhardoj]

The root cause of the issue is actually not directly related to the PR. We already have a logic here to show Pending... if the distance is 0 or doesn't exist.

App/src/libs/DistanceRequestUtils.ts

Lines 164 to 167 in f9306d5

	function getDistanceForDisplay(hasRoute: boolean, distanceInMeters: number, unit: Unit | undefined, rate: number | undefined, translate: LocaleContextProps['translate']): string {
	if (!hasRoute || !rate || !unit || !distanceInMeters) {
	return translate('iou.fieldPending');
	}

The distance comes from either customUnit.quantity or routes.route0.distance. However, when we remove the waypoint, we don't clear the customUnit.quantity.

App/src/libs/actions/Transaction.ts

Lines 161 to 191 in f9306d5

	let newTransaction: Transaction = {
	// eslint-disable-next-line @typescript-eslint/non-nullable-type-assertion-style
	...(transaction as Transaction),
	comment: {
	...transaction?.comment,
	waypoints: reIndexedWaypoints,
	},
	// We want to reset the amount only for draft transactions (when creating the expense).
	// When modifying an existing transaction, the amount will be updated on the actual IOU update operation.
	...(isDraft && {amount: CONST.IOU.DEFAULT_AMOUNT}),
	};
	if (!isRemovedWaypointEmpty) {
	newTransaction = {
	...newTransaction,
	// Clear any errors that may be present, which apply to the old route
	errorFields: {
	route: null,
	},
	// Clear the existing route so that we don't show an old route
	routes: {
	route0: {
	// Clear the existing distance to recalculate next time
	distance: null,
	geometry: {
	coordinates: null,
	},
	},
	},
	};
	}

But we did remove it when adding waypoints.

App/src/libs/actions/Transaction.ts

Lines 85 to 113 in f9306d5

	Onyx.merge(`${isDraft ? ONYXKEYS.COLLECTION.TRANSACTION_DRAFT : ONYXKEYS.COLLECTION.TRANSACTION}${transactionID}`, {
	comment: {
	waypoints: {
	[`waypoint${index}`]: waypoint,
	},
	customUnit: {
	quantity: null,
	},
	},
	// We want to reset the amount only for draft transactions (when creating the expense).
	// When modifying an existing transaction, the amount will be updated on the actual IOU update operation.
	...(isDraft && {amount: CONST.IOU.DEFAULT_AMOUNT}),
	// Empty out errors when we're saving a new waypoint as this indicates the user is updating their input
	errorFields: {
	route: null,
	},
	// Clear the existing route so that we don't show an old route
	routes: {
	route0: {
	// Clear the existing distance to recalculate next time
	distance: null,
	geometry: {
	coordinates: null,
	},
	},
	},
	});

That's why the issue doesn't happen when adding waypoint while offline. This issue just became apparent after my PR. Previously, we shows Pending when updating the waypoint even if the distance value is already updated. Now, Pending will only show if the distance value is not available yet.

I have open a new PR to address this issue without breaking #43569

[melvin-bot]

⚠️ Looks like this issue was linked to a Deploy Blocker here

If you are the assigned CME please investigate whether the linked PR caused a regression and leave a comment with the results.

If a regression has occurred and you are the assigned CM follow the instructions here.

If this regression could have been avoided please consider also proposing a recommendation to the PR checklist so that we can avoid it in the future.

[melvin-bot]

This issue has not been updated in over 15 days. @anmurali, @parasharrajat, @grgia, @bernhardoj eroding to Monthly issue.

P.S. Is everyone reading this sure this is really a near-term priority? Be brave: if you disagree, go ahead and close it out. If someone disagrees, they'll reopen it, and if they don't: one less thing to do!

[bernhardoj]

We can close this one

[parasharrajat]

Good to close @anmurali

[melvin-bot]

@anmurali, @parasharrajat, @grgia, @bernhardoj, this Monthly task hasn't been acted upon in 6 weeks; closing.

If you disagree, feel encouraged to reopen it -- but pick your least important issue to close instead.