add todo comments for routing and map components

Author: josh-willis-arcadis

lib/editor/util/map.js

@@ -262,6 +262,7 @@ export function getPatternEndPoint (pattern: Pattern, controlPoints?: Array<Cont
   throw new Error('Control point is missing coordinates')
 }
 
+// RAIL-TODO: remove followRoad for generic routing options
 /* eslint-disable complexity */
 export async function recalculateShape ({
   avoidMotorways = false,
@@ -396,6 +397,7 @@ export async function recalculateShape ({
     throw new Error('Invalid editType. Must be either "update" or "delete".')
   }
   // calculate new segment (valhalla or straight line)
+  // RAIL-TODO: remove followRoad for generic routing options
   const newSegment = await getSegment(
     pointsToRoute,
     followStreets,

lib/scenario-editor/utils/valhalla.js

@@ -134,7 +134,7 @@ export async function polyline (
       const beginIndex = i + offset
       const endIndex = i + chunk + offset
       const chunkedPoints = points.slice(beginIndex, endIndex)
-      json = await routeWithGraphHopper(chunkedPoints, avoidMotorways)
+      json = await routeWithGraphHopper(chunkedPoints, avoidMotorways) // RAIL-TODO: if snap to rail is enabled, use rail routing
       const path = json && json.paths && json.paths[0]
       // Route between chunked list of points
       if (path) {
@@ -154,6 +154,7 @@ export async function polyline (
   }
 }
 
+// RAIL-TODO: remove followRoad for generic routing options
 export async function getSegment (
   points: Coordinates,
   followRoad: boolean,
@@ -165,7 +166,7 @@ export async function getSegment (
 }> {
   // Store geometry to be returned here.
   let geometry
-  if (followRoad) {
+  if (followRoad) { // RAIL-TODO: remove followRoad and use new state variable
     // if snapping to streets, use routing service.
     const coordinates = await polyline(
       points.map(p => ({lng: p[0], lat: p[1]})),

lib/types/reducers.js

@@ -216,6 +216,7 @@ export type EditSettingsState = {
   currentDragId: null | string,
   distanceFromIntersection: number,
   editGeometry: boolean,
+  followRail: boolean,
   followStreets: boolean,
   hideInactiveSegments: boolean,
   hideStopHandles: boolean,