[HOLD for payment 2023-10-09] [$500] [Distance] - Route is generated without green line connecting the points after going online

[lanitochka17]

If you haven’t already, check out our contributing guidelines for onboarding and email contributors@expensify.com to request to join our Slack channel!

---

Issue found when executing PR #25980

Action Performed:

1. Go to staging.new.expensify.com
2. Go offline
3. Go to + > Request money > Distance
4. Go to Start > Select address 1 Telegraph Hill Blvd, San Francisco, CA 94133, USA
5. Go to Finish > Select address 88 Kearny St, San Francisco, CA 94108, USA
6. Go online

Expected Result:

The route is generated from the start to the finish point with a green line connecting

Actual Result:

The route is generated without a green line connecting the start and finish point

Workaround:

Unknown

Platforms:

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

• Android / native
• Android / Chrome
• iOS / native
• iOS / Safari
• MacOS / Chrome / Safari
• MacOS / Desktop

Version Number: 1.3.62-1

Reproducible in staging?: Yes

Reproducible in production?: Yes

If this was caught during regression testing, add the test name, ID and link from TestRail:

Email or phone of affected tester (no customers):

Logs: https://stackoverflow.com/c/expensify/questions/4856

Notes/Photos/Videos: Any additional supporting documentation

Bug6186274_20230902_222139.mp4

Expensify/Expensify Issue URL:

Issue reported by: Applause - Internal Team

Slack conversation:

View all open jobs on GitHub

Upwork Automation - Do Not Edit

• Upwork Job URL: https://www.upwork.com/jobs/~017f0ebdf18950167a
• Upwork Job ID: 1699079489951641600
• Last Price Increase: 2023-09-05
• Automatic offers:
• ntdiary | Reviewer | 26511344
• pradeepmdk | Contributor | 26511347

[melvin-bot]

Triggered auto assignment to @sakluger (Bug), see https://stackoverflow.com/c/expensify/questions/14418 for more details.

[melvin-bot]

Bug0 Triage Checklist (Main S/O)

• This "bug" occurs on a supported platform (ensure Platforms in OP are ✅)
• This bug is not a duplicate report (check E/App issues and #expensify-bugs)
  • If it is, comment with a link to the original report, close the issue and add any novel details to the original issue instead
• This bug is reproducible using the reproduction steps in the OP. S/O
  • If the reproduction steps are clear and you're unable to reproduce the bug, check with the reporter and QA first, then close the issue.
  • If the reproduction steps aren't clear and you determine the correct steps, please update the OP.
• This issue is filled out as thoroughly and clearly as possible
  • Pay special attention to the title, results, platforms where the bug occurs, and if the bug happens on staging/production.
• I have reviewed and subscribed to the linked Slack conversation to ensure Slack/Github stay in sync

[hoangzinh]

Proposal

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

Distance - Route is generated without green line connecting the points after going online

What is the root cause of that problem?

We already have a logic to fetch the route if needed

App/src/components/DistanceRequest.js

Lines 153 to 159 in e088539

	useEffect(() => {
	if (isOffline || !shouldFetchRoute) {
	return;
	}
	Transaction.getRoute(iou.transactionID, waypoints);
	}, [shouldFetchRoute, iou.transactionID, waypoints, isOffline]);

But the issue is shouldFetchRoute doesn't set correctly

App/src/components/DistanceRequest.js

Lines 92 to 93 in e088539

	const doesRouteExist = lodashHas(transaction, 'routes.route0.geometry.coordinates');
	const shouldFetchRoute = (!doesRouteExist || haveWaypointsChanged) && !isLoadingRoute && TransactionUtils.validateWaypoints(waypoints);

It checks doesRouteExist but we use lodashHas so it only check whether we have that key in an object, it doesn't check the value of it. In this case, even transaction.routes.route0.geometry.coordinates is null but it still returns true => It would make shouldFetchRoute is false => doesn't fetch the route when network is online back.

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

We should check the value of transaction.routes.route0.geometry.coordinates is exist or not instead of checking its key in this line => it will make shouldFetchRoute is true => will fetch the route when network is online back.

What alternative solutions did you explore? (Optional)

In the optimistic data when we saveWaypoint/addStop/removeWaypoint, we set transaction.routes.route0.geometry.coordinates to null

App/src/libs/actions/Transaction.js

Lines 89 to 95 in e088539

	routes: {
	route0: {
	geometry: {
	coordinates: null,
	},
	},
	},

I think we can change it to set transaction.routes or transaction.routes.route0 is null. It will make the line check lodashHas key above work more properly.

[hayata-suenaga]

Proposal
Please re-state the problem that we are trying to solve in this issue.
Display route line when the device comes back online

What is the root cause of that problem?
App/src/components/DistanceRequest.js

Line 92 in d0b2772

const doesRouteExist = lodashHas(transaction, 'routes.route0.geometry.coordinates');

here we are checking the coordinates key or not so its will be always true
because coordinates we are setting as null every every waypoint save
App/src/libs/actions/Transaction.js

Line 63 in d0b2772

coordinates: null,

but its have null value so that when come back online
App/src/components/DistanceRequest.js

Line 158 in d0b2772

Transaction.getRoute(iou.transactionID, waypoints);
not triggering this one
What changes do you think we should make in order to solve the problem?
we should update the logic

const doesRouteExist = lodashHas(transaction, 'routes.route0.geometry.coordinates') && transaction.routes.route0.geometry.coordinates && transaction. routes.route0.geometry.type;

token init as well we should update

useEffect(() => {
    if(isOffline) {
        return;
    }
    MapboxToken.init();
    return MapboxToken.stop;
}, [isOffline]);

when refresh as well working fine

This is a proposal from @pradeepmdk from this dupe issue (which I closed).

This proposal looks good. I'll assign @pradeepmdk

@pradeepmdk I don't think we have to call MapboxToken.init() when the device comes back online. I believe MapboxToken.init() already handles that situation. Could you test without the change in the useEffect for MapboxToken.init() and see if the code still works?

@hoangzinh thank you for letting me know about the dupe. You identified the cause correctly, but I don't believe we need to update the logic for optimistic update. I prefer we set the key but leave the value null (I believe this is the pattern we use across App).

[hayata-suenaga]

Also, @pradeepmdk could you comment something on this issue? Otherwise, I cannot assign you 😓

[pradeepmdk]

from #26596 (comment)

Proposal

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

Display route line when the device comes back online

What is the root cause of that problem?

App/src/components/DistanceRequest.js

Line 92 in d0b2772

const doesRouteExist = lodashHas(transaction, 'routes.route0.geometry.coordinates');

here we are checking the coordinates key or not so its will be always true
because coordinates we are setting as null every every waypoint save

App/src/libs/actions/Transaction.js

Line 63 in d0b2772

coordinates: null,

but its have null value so that when come back online

App/src/components/DistanceRequest.js

Line 158 in d0b2772

Transaction.getRoute(iou.transactionID, waypoints);

not triggering this one

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

we should update the logic

    const doesRouteExist = lodashHas(transaction, 'routes.route0.geometry.coordinates') && transaction.routes.route0.geometry.coordinates && transaction. routes.route0.geometry.type;

or
we can use null check from lodash

const doesRouteExist = !_.isNull(transaction, 'routes.route0.geometry.coordinates')

Or we can check coordinate is an array so if not an array also we use it here from Lodash
when refresh as well working fine

[0xmiroslav]

I can take C+ role here as I was assigned on related issue but closed

[pradeepmdk]

@hayata-suenaga Yes we don't need that MapboxToken.init() because when coming back online GetMapboxAccessToken API is triggering.

[b4s36t4]

Proposal

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

Distance - Route is generated without green line connecting the points after going online

What is the root cause of that problem?

Coordinates are null and we're not fetching route by calling getROute method even if go offline.

https://github.com/Expensify/App/blob/aeffabf2d39af8ef03440d5d69bcb074d1826dd7/src/components/DistanceRequest.js#L92 this will be true even if we have null.

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

We could simply change it to the following line.

    const doesRouteExist = lodashGet(transaction, 'routes.route0.geometry.coordinates') !== null;

This will set https://github.com/Expensify/App/blob/aeffabf2d39af8ef03440d5d69bcb074d1826dd7/src/components/DistanceRequest.js#L93 true when we come back online this will trigger route calling api.

What alternative solutions did you explore? (Optional)

NA

Result

Kapture.2023-09-04.at.10.17.37.mp4