Merge pull request #25434 from Expensify/jack-add-map-display-route

Display Route

package.json

@@ -147,7 +147,7 @@
     "react-native-web-linear-gradient": "^1.1.2",
     "react-native-web-lottie": "^1.4.4",
     "react-native-webview": "^11.17.2",
-    "react-native-x-maps": "^1.0.9",
+    "react-native-x-maps": "1.0.10",
     "react-pdf": "^6.2.2",
     "react-plaid-link": "3.3.2",
     "react-web-config": "^1.0.0",

src/components/DistanceRequest.js

@@ -7,6 +7,7 @@ import {withOnyx} from 'react-native-onyx';
 import MapView from 'react-native-x-maps';
 import ONYXKEYS from '../ONYXKEYS';
 import * as Transaction from '../libs/actions/Transaction';
+import * as TransactionUtils from '../libs/TransactionUtils';
 import MenuItemWithTopDescription from './MenuItemWithTopDescription';
 import * as Expensicons from './Icon/Expensicons';
 import theme from '../styles/themes/default';
@@ -21,6 +22,10 @@ import useNetwork from '../hooks/useNetwork';
 import useLocalize from '../hooks/useLocalize';
 import Navigation from '../libs/Navigation/Navigation';
 import ROUTES from '../ROUTES';
+import ScreenWrapper from './ScreenWrapper';
+import DotIndicatorMessage from './DotIndicatorMessage';
+import * as ErrorUtils from '../libs/ErrorUtils';
+import usePrevious from '../hooks/usePrevious';
 
 const MAX_WAYPOINTS = 25;
 const MAX_WAYPOINTS_TO_DISPLAY = 4;
@@ -51,6 +56,9 @@ const propTypes = {
                 address: PropTypes.string,
             }),
         }),
+
+        /** Server side errors keyed by microtime */
+        errorFields: PropTypes.objectOf(PropTypes.objectOf(PropTypes.string)),
     }),
 
     /** Data about Mapbox token for calling Mapbox API */
@@ -78,7 +86,13 @@ function DistanceRequest({transactionID, transaction, mapboxAccessToken}) {
 
     const waypoints = lodashGet(transaction, 'comment.waypoints', {});
     const numberOfWaypoints = _.size(waypoints);
+
     const lastWaypointIndex = numberOfWaypoints - 1;
+    const isLoadingRoute = lodashGet(transaction, 'comment.isLoading', false);
+    const hasRouteError = Boolean(lodashGet(transaction, 'errorFields.route'));
+    const previousWaypoints = usePrevious(waypoints);
+    const haveWaypointsChanged = !_.isEqual(previousWaypoints, waypoints);
+    const shouldFetchRoute = haveWaypointsChanged && !isOffline && !isLoadingRoute && TransactionUtils.validateWaypoints(waypoints);
 
     const waypointMarkers = _.filter(
         _.map(waypoints, (waypoint, key) => {
@@ -133,10 +147,19 @@ function DistanceRequest({transactionID, transaction, mapboxAccessToken}) {
         setShouldShowGradient(visibleAreaEnd < scrollContentHeight);
     };
 
+    // Handle fetching the route when there are at least 2 waypoints
+    useEffect(() => {
+        if (!shouldFetchRoute) {
+            return;
+        }
+
+        Transaction.getRoute(transactionID, waypoints);
+    }, [shouldFetchRoute, transactionID, waypoints]);
+
     useEffect(updateGradientVisibility, [scrollContainerHeight, scrollContentHeight]);
 
     return (
-        <>
+        <ScreenWrapper shouldEnableMaxHeight>
             <View
                 style={styles.distanceRequestContainer(scrollContainerMaxHeight)}
                 onLayout={(event = {}) => setScrollContainerHeight(lodashGet(event, 'nativeEvent.layout.height', 0))}
@@ -183,6 +206,13 @@ function DistanceRequest({transactionID, transaction, mapboxAccessToken}) {
                         colors={[theme.transparent, theme.modalBackground]}
                     />
                 )}
+                {hasRouteError && (
+                    <DotIndicatorMessage
+                        style={[styles.mh5, styles.mv3]}
+                        messages={ErrorUtils.getLatestErrorField(transaction, 'route')}
+                        type="error"
+                    />
+                )}
             </View>
             <View style={[styles.flexRow, styles.justifyContentCenter, styles.pt1]}>
                 <Button
@@ -204,6 +234,8 @@ function DistanceRequest({transactionID, transaction, mapboxAccessToken}) {
                             location: CONST.SF_COORDINATES,
                             zoom: DEFAULT_ZOOM_LEVEL,
                         }}
+                        directionCoordinates={lodashGet(transaction, 'routes.route0.geometry.coordinates', [])}
+                        directionStyle={styles.mapDirection}
                         style={styles.mapView}
                         waypoints={waypointMarkers}
                         styleURL={CONST.MAPBOX_STYLE_URL}
@@ -219,7 +251,7 @@ function DistanceRequest({transactionID, transaction, mapboxAccessToken}) {
                     </View>
                 )}
             </View>
-        </>
+        </ScreenWrapper>
     );
 }
 
@@ -229,7 +261,6 @@ DistanceRequest.defaultProps = defaultProps;
 export default withOnyx({
     transaction: {
         key: (props) => `${ONYXKEYS.COLLECTION.TRANSACTION}${props.transactionID}`,
-        selector: (transaction) => (transaction ? {transactionID: transaction.transactionID, comment: {waypoints: lodashGet(transaction, 'comment.waypoints')}} : null),
     },
     mapboxAccessToken: {
         key: ONYXKEYS.MAPBOX_ACCESS_TOKEN,

src/libs/TransactionUtils.js

@@ -244,6 +244,37 @@ function isReceiptBeingScanned(transaction) {
 }
 
 /**
+ * Verifies that the provided waypoints are valid
+ * @param {Object} waypoints
+ * @returns {Boolean}
+ */
+function validateWaypoints(waypoints) {
+    const waypointValues = _.values(waypoints);
+
+    // Ensure the number of waypoints is between 2 and 25
+    if (waypointValues.length < 2 || waypointValues.length > 25) {
+        return false;
+    }
+
+    for (let i = 0; i < waypointValues.length; i++) {
+        const currentWaypoint = waypointValues[i];
+        const previousWaypoint = waypointValues[i - 1];
+
+        // Check if the waypoint has a valid address
+        if (!currentWaypoint || !currentWaypoint.address || typeof currentWaypoint.address !== 'string' || currentWaypoint.address.trim() === '') {
+            return false;
+        }
+
+        // Check for adjacent waypoints with the same address
+        if (previousWaypoint && currentWaypoint.address === previousWaypoint.address) {
+            return false;
+        }
+    }
+
+    return true;
+}
+
+/*
  * @param {Object} transaction
  * @param {String} transaction.type
  * @param {Object} [transaction.customUnit]
@@ -269,5 +300,6 @@ export {
     getAllReportTransactions,
     hasReceipt,
     isReceiptBeingScanned,
+    validateWaypoints,
     isDistanceRequest,
 };

src/libs/actions/Transaction.js

@@ -3,6 +3,7 @@ import Onyx from 'react-native-onyx';
 import lodashGet from 'lodash/get';
 import ONYXKEYS from '../../ONYXKEYS';
 import * as CollectionUtils from '../CollectionUtils';
+import * as API from '../API';
 
 const allTransactions = {};
 Onyx.connect({
@@ -47,6 +48,15 @@ function addStop(transactionID) {
                 [`waypoint${newLastIndex}`]: {},
             },
         },
+
+        // Clear the existing route so that we don't show an old route
+        routes: {
+            route0: {
+                geometry: {
+                    coordinates: null,
+                },
+            },
+        },
     });
 }
 
@@ -63,6 +73,19 @@ function saveWaypoint(transactionID, index, waypoint) {
                 [`waypoint${index}`]: waypoint,
             },
         },
+        // 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: {
+                geometry: {
+                    coordinates: null,
+                },
+            },
+        },
     });
 }
 
@@ -96,8 +119,72 @@ function removeWaypoint(transactionID, currentIndex) {
             ...transaction.comment,
             waypoints: reIndexedWaypoints,
         },
+        // Clear the existing route so that we don't show an old route
+        routes: {
+            route0: {
+                geometry: {
+                    coordinates: null,
+                },
+            },
+        },
     };
     Onyx.set(`${ONYXKEYS.COLLECTION.TRANSACTION}${transactionID}`, newTransaction);
 }
 
-export {addStop, createInitialWaypoints, saveWaypoint, removeWaypoint};
+/**
+ * Gets the route for a set of waypoints
+ * Used so we can generate a map view of the provided waypoints
+ * @param {String} transactionID
+ * @param {Object} waypoints
+ */
+function getRoute(transactionID, waypoints) {
+    API.read(
+        'GetRoute',
+        {
+            transactionID,
+            waypoints: JSON.stringify(waypoints),
+        },
+        {
+            optimisticData: [
+                {
+                    // Clears any potentially stale error messages from fetching the route
+                    onyxMethod: Onyx.METHOD.MERGE,
+                    key: `${ONYXKEYS.COLLECTION.TRANSACTION}${transactionID}`,
+                    value: {
+                        comment: {
+                            isLoading: true,
+                        },
+                        errorFields: {
+                            route: null,
+                        },
+                    },
+                },
+            ],
+            // The route and failure are sent back via pusher in the BE, we are just clearing the loading state here
+            successData: [
+                {
+                    onyxMethod: Onyx.METHOD.MERGE,
+                    key: `${ONYXKEYS.COLLECTION.TRANSACTION}${transactionID}`,
+                    value: {
+                        comment: {
+                            isLoading: false,
+                        },
+                    },
+                },
+            ],
+            failureData: [
+                {
+                    onyxMethod: Onyx.METHOD.MERGE,
+                    key: `${ONYXKEYS.COLLECTION.TRANSACTION}${transactionID}`,
+                    value: {
+                        comment: {
+                            isLoading: false,
+                        },
+                    },
+                },
+            ],
+        },
+    );
+}
+
+export {addStop, createInitialWaypoints, saveWaypoint, removeWaypoint, getRoute};

src/styles/styles.js

@@ -3835,6 +3835,11 @@ const styles = {
         overflow: 'hidden',
     },
 
+    mapDirection: {
+        width: 7,
+        color: Colors.green,
+    },
+
     mapPendingView: {
         backgroundColor: themeColors.highlightBG,
         ...flex.flex1,