[2/2] Fix v3 naming schemes & add back dummy endpoints to ensure back compat (#313)

Author: alanna-zhou

src/API.js

@@ -23,6 +23,7 @@ class API extends ApplicationAPI {
       Routers.MultiRouteRouter,
       Routers.PlacesAutocompleteRouter,
       Routers.PlaceIDCoordinatesRouter,
+      Routers.RouteSelectedRouter,
       Routers.SearchRouter,
     ];
     return {

src/routers/index.js

@@ -11,6 +11,7 @@ import MultiRouteRouter from './v1/MultiRouteRouter';
 import PlacesAutocompleteRouter from './v1/PlacesAutocompleteRouter';
 import PlaceIDCoordinatesRouter from './v1/PlaceIDCoordinatesRouter';
 import RouteRouter from './v1/RouteRouter';
+import RouteSelectedRouter from './v1/RouteSelectedRouter';
 import RouteV2Router from './v2/RouteRouter';
 import RouteV3Router from './v3/RouteRouter';
 import SearchRouter from './v1/SearchRouter';
@@ -31,6 +32,7 @@ export default {
   PlacesAutocompleteRouter,
   PlaceIDCoordinatesRouter,
   RouteRouter,
+  RouteSelectedRouter,
   RouteV2Router,
   RouteV3Router,
   SearchRouter,

src/routers/v1/RouteRouter.js

@@ -1,5 +1,6 @@
 // @flow
 import type Request from 'express';
+import AnalyticsUtils from '../../utils/AnalyticsUtils';
 import ApplicationRouter from '../../appdev/ApplicationRouter';
 import LogUtils from '../../utils/LogUtils';
 import RouteUtils from '../../utils/RouteUtils';
@@ -42,6 +43,8 @@ class RouteRouter extends ApplicationRouter<Array<Object>> {
       };
       LogUtils.log({ category: 'routeRequestWithTransfer', request });
     }
+    AnalyticsUtils.assignRouteIdsAndCache(routes);
+
     return routes;
   }
 }

src/routers/v1/RouteSelectedRouter.js

@@ -0,0 +1,20 @@
+// @flow
+import type Request from 'express';
+import ApplicationRouter from '../../appdev/ApplicationRouter';
+
+class RouteSelectedRouter extends ApplicationRouter<Array<Object>> {
+  constructor() {
+    super(['POST']);
+  }
+
+  getPath(): string {
+    return '/routeSelected/';
+  }
+
+  // eslint-disable-next-line require-await
+  async content(req: Request): Promise<any> {
+    return null;
+  }
+}
+
+export default new RouteSelectedRouter().router;

src/routers/v2/RouteRouter.js

@@ -1,5 +1,6 @@
 // @flow
 import type Request from 'express';
+import AnalyticsUtils from '../../utils/AnalyticsUtils';
 import ApplicationRouter from '../../appdev/ApplicationRouter';
 import LogUtils from '../../utils/LogUtils';
 import RouteUtils from '../../utils/RouteUtils';
@@ -44,13 +45,14 @@ class RouteRouter extends ApplicationRouter<Object> {
         destinationName,
         end: routes[0].endCoords,
         originName,
-        routeId: routes[0].routeId,
+        routeId: null,
         start: routes[0].startCoords,
         time,
         uid,
       };
       LogUtils.log({ category: 'routeRequest', request });
     }
+    AnalyticsUtils.assignRouteIdsAndCache(routes);
     return sectionedRoutes;
   }
 }

src/utils/AnalyticsUtils.js

@@ -0,0 +1,17 @@
+// @flow
+import crypto from 'crypto';
+
+function getUniqueId(numBytes: ?number = 10) {
+  return crypto.randomBytes(numBytes).toString('hex');
+}
+
+function assignRouteIdsAndCache(routeRes: Object[]) {
+  routeRes.forEach((route) => {
+    route.routeId = getUniqueId();
+  });
+}
+
+export default {
+  getUniqueId,
+  assignRouteIdsAndCache,
+};

src/utils/RealtimeFeedUtilsV3.js

@@ -23,17 +23,14 @@ async function fetchVehicles(): Object {
 }
 
 /**
- * Given an array of { routeID, tripID },
+ * Given an array of { routeId, tripId },
  * Return bus information
  * Input:[
  * {
- * routeID : String,
- * tripID : String
+ * routeId : String,
+ * tripId : String
  * },... ]
- * NOTE: Because we need to provide backwards compatibility with old iOS clients
- * we have to follow their janky way of routeID input is String but routeID
- * output is Number. This "routeID" is also named jankily, which is supposed to
- * be routeNumber from v2/route/. We cast this to Number in getVehicleInformation.
+ * Corresponds to GTFS RouteId and TripId.
  *
  *
  */
@@ -116,6 +113,7 @@ function getVehicleInformation(
     return null;
   }
   const vehicleData = Object.values(vehicles).find(
+    // Naming here is routeID and tripID due to how the microservice names fields
     v => (v.routeID === routeId) && (v.tripID === tripId),
   );
   if (!vehicleData) {