Add v3/tracking and update v3/delays, v3/route, and swagger docs (#312)

Author: alanna-zhou

docker-compose.yml

@@ -13,7 +13,7 @@ services:
       - /usr/src/app/node_modules
 
   ghopper:
-    image: cornellappdev/transit-ghopper:v1.2.8
+    image: cornellappdev/transit-ghopper:v1.2.9
     ports:
       - "8988:8988"
 

src/API.js

@@ -19,29 +19,31 @@ class API extends ApplicationAPI {
       Routers.AllStopsRouter,
       Routers.ApplePlacesRouter,
       Routers.AppleSearchRouter,
-      Routers.DelayRouter,
-      Routers.DelaysRouter,
       Routers.HelloWorldRouter,
       Routers.MultiRouteRouter,
       Routers.PlacesAutocompleteRouter,
       Routers.PlaceIDCoordinatesRouter,
-      Routers.RouteSelectedRouter,
       Routers.SearchRouter,
-      Routers.TrackingRouter,
     ];
     return {
       docs: [Routers.DocsRouter],
       v1: [
         ...sharedRouters,
         Routers.RouteRouter,
+        Routers.DelayRouter,
+        Routers.TrackingRouter,
       ],
       v2: [
         ...sharedRouters,
         Routers.RouteV2Router,
+        Routers.DelaysV2Router,
+        Routers.TrackingRouter,
       ],
       v3: [
         ...sharedRouters,
         Routers.RouteV3Router,
+        Routers.DelaysV3Router,
+        Routers.TrackingV3Router,
       ],
     };
   }

src/routers/index.js

@@ -3,35 +3,37 @@ import AllStopsRouter from './v1/AllStopsRouter';
 import ApplePlacesRouter from './v1/ApplePlacesRouter';
 import AppleSearchRouter from './v1/AppleSearchRouter';
 import DelayRouter from './v1/DelayRouter';
-import DelaysRouter from './v2/DelaysRouter';
+import DelaysV2Router from './v2/DelaysRouter';
+import DelaysV3Router from './v3/DelaysRouter';
 import DocsRouter from './DocsRouter';
 import HelloWorldRouter from './v1/HelloWorldRouter';
 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';
 import TrackingRouter from './v1/TrackingRouter';
+import TrackingV3Router from './v3/TrackingRouter';
 
 export default {
   AlertsRouter,
   AllStopsRouter,
   ApplePlacesRouter,
   AppleSearchRouter,
   DelayRouter,
-  DelaysRouter,
+  DelaysV2Router,
+  DelaysV3Router,
   DocsRouter,
   HelloWorldRouter,
   MultiRouteRouter,
   PlacesAutocompleteRouter,
   PlaceIDCoordinatesRouter,
   RouteRouter,
-  RouteSelectedRouter,
   RouteV2Router,
   RouteV3Router,
   SearchRouter,
   TrackingRouter,
+  TrackingV3Router,
 };

src/routers/v1/MultiRouteRouter.js

@@ -1,6 +1,5 @@
 // @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';
@@ -50,7 +49,6 @@ class MultiRouteRouter extends ApplicationRouter<Array<Object>> {
     // return the best route for each destination
     return Promise.all(multiRoutes).then((val) => {
       const bestRoutes = val.map(routes => (routes.length > 0 ? routes[0] : null));
-      AnalyticsUtils.assignRouteIdsAndCache(bestRoutes.filter(Boolean));
       return bestRoutes;
     }).catch((err) => {
       throw LogUtils.logErr(err, multiRoutes, 'Could not get all specified routes');

src/routers/v1/RouteRouter.js

@@ -1,6 +1,5 @@
 // @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';
@@ -43,8 +42,6 @@ class RouteRouter extends ApplicationRouter<Array<Object>> {
       };
       LogUtils.log({ category: 'routeRequestWithTransfer', request });
     }
-    AnalyticsUtils.assignRouteIdsAndCache(routes);
-
     return routes;
   }
 }

src/routers/v1/RouteSelectedRouter.js

@@ -1,6 +1,5 @@
 // @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';
@@ -52,8 +51,6 @@ class RouteRouter extends ApplicationRouter<Object> {
       };
       LogUtils.log({ category: 'routeRequest', request });
     }
-    AnalyticsUtils.assignRouteIdsAndCache(routes);
-
     return sectionedRoutes;
   }
 }

src/routers/v2/RouteRouter.js

@@ -0,0 +1,30 @@
+// @flow
+import ApplicationRouter from '../../appdev/ApplicationRouter';
+import RealtimeFeedUtils from '../../utils/RealtimeFeedUtilsV3';
+
+class DelaysRouter extends ApplicationRouter<Object> {
+  constructor() {
+    super(['POST']);
+  }
+
+  getPath(): string {
+    return '/delays/';
+  }
+
+  async content(req): Promise<any> {
+    const rtf = await RealtimeFeedUtils.fetchRTF();
+    const delays = req.body.data.map(async ({ stopId, tripId }) => {
+      const res = await RealtimeFeedUtils.getDelayInformation(
+        stopId, tripId, rtf,
+      );
+      return {
+        stopId,
+        tripId,
+        delay: res ? res.delay : null,
+      };
+    });
+    return Promise.all(delays);
+  }
+}
+
+export default new DelaysRouter().router;

src/routers/v3/DelaysRouter.js

@@ -1,6 +1,5 @@
 // @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/RouteUtilsV3';
@@ -45,15 +44,12 @@ class RouteRouter extends ApplicationRouter<Object> {
         destinationName,
         end: routes[0].endCoords,
         originName,
-        routeId: routes[0].routeId,
         start: routes[0].startCoords,
         time,
         uid,
       };
       LogUtils.log({ category: 'routeRequest', request });
     }
-    AnalyticsUtils.assignRouteIdsAndCache(routes);
-
     return sectionedRoutes;
   }
 }

src/routers/v3/RouteRouter.js

@@ -0,0 +1,27 @@
+// @flow
+import ApplicationRouter from '../../appdev/ApplicationRouter';
+import RealtimeFeedUtils from '../../utils/RealtimeFeedUtilsV3';
+
+class TrackingRouter extends ApplicationRouter<Object> {
+  constructor() {
+    super(['POST']);
+  }
+
+  getPath(): string {
+    return '/tracking/';
+  }
+
+  // eslint-disable-next-line require-await
+  async content(req): Promise<any> {
+    if (!req.body || !req.body.data || !req.body.data.length || req.body.data.length === 0) {
+      return {
+        case: 'invalidRequest',
+      };
+    }
+
+    const { data } = req.body;
+    return RealtimeFeedUtils.getTrackingResponse(data);
+  }
+}
+
+export default new TrackingRouter().router;