Refactor /tracking to make requests to the microservice and return valid vehicle info (#292)

Author: alanna-zhou

docker-compose.yml

@@ -13,7 +13,7 @@ services:
       - /usr/src/app/node_modules
 
   ghopper:
-    image: cornellappdev/transit-ghopper:v1.1.8
+    image: cornellappdev/transit-ghopper:v1.2.1
     ports:
       - "8988:8988"
 
@@ -28,7 +28,7 @@ services:
       - "8987:8987"
 
   live-tracking:
-    image: cornellappdev/transit-python:v1.1.8
+    image: cornellappdev/transit-python:alanna
     env_file: python.envrc
     ports:
       - "5000:5000"

src/utils/RealtimeFeedUtils.js

@@ -3,140 +3,53 @@ import { PYTHON_APP } from './EnvUtils';
 import Constants from './Constants';
 import LogUtils from './LogUtils';
 import RequestUtils from './RequestUtils';
-import TokenUtils from './TokenUtils';
 
 async function fetchRTF(): Object {
   const options = {
     ...Constants.GET_OPTIONS,
     url: `http://${PYTHON_APP || 'localhost'}:5000/rtf`,
   };
-  const data = await RequestUtils.createRequest(options, 'Tracking request failed');
+  const data = await RequestUtils.createRequest(options, 'RTF request failed');
+  return JSON.parse(data);
+}
+
+async function fetchVehicles(): Object {
+  const options = {
+    ...Constants.GET_OPTIONS,
+    url: `http://${PYTHON_APP || 'localhost'}:5000/vehicles`,
+  };
+  const data = await RequestUtils.createRequest(options, 'Vehicles request failed');
   return JSON.parse(data);
 }
 
 /**
- * Given an array of { stopID, routeID, [tripID] },
- * Return bus and tracking data including location
+ * Given an array of { routeID, tripID },
+ * Return bus information
  * Input:
  [
  {
-   “stopID” : String,
    “routeID” : String,
-   “tripIdentifiers” : [String]
+   tripID : String
  },
  …
  ]
  */
 async function getTrackingResponse(requestData: Object): Object {
   LogUtils.log({ message: 'getTrackingResponse: entering function' });
-
-  const trackingInformation = [];
-  const rtf = await fetchRTF(); // ensures the realtimeFeed doesn't update in the middle of execution
-
-  // for each input
-  await Promise.all(requestData.map(async (data): Promise<boolean> => {
-    const { stopID, routeID, tripIdentifiers } = data;
-    const realtimeDelayData = getDelayInformation(stopID, tripIdentifiers[0], rtf);
-
-    if (realtimeDelayData) {
-      const authHeader = await TokenUtils.fetchAuthHeader();
-      const options = {
-        method: 'GET',
-        url: 'https://gateway.api.cloud.wso2.com:443/t/mystop/tcat/v1/rest/Vehicles/GetAllVehiclesForRoute',
-        headers: {
-          Authorization: authHeader,
-          'Cache-Control': 'no-cache',
-          'Postman-Token': 'b688b636-87ea-4e04-9f3e-ba34e811e639',
-        },
-        qs: { routeID },
-      };
-
-      const trackingRequest = await RequestUtils.createRequest(options, 'Tracking request failed');
-      if (!trackingRequest) return false;
-
-      /**
-       * Parse request to object and map valid realtime data to info for each bus
-       */
-      const busFound = JSON.parse(trackingRequest) // parse the request
-        .find( // find the first tracking data matching the vehicleId
-          busInfo => busInfo.VehicleId === realtimeDelayData.vehicleId,
-        );
-
-      if (!busFound) return false;
-
-      const trackingData = ((busInfo) => { // create object and return
-        let lastUpdated = busInfo.LastUpdated;
-        const firstParan = lastUpdated.indexOf('(') + 1;
-        const secondParan = lastUpdated.indexOf('-');
-        lastUpdated = parseInt(lastUpdated.slice(firstParan, secondParan));
-        return {
-          case: 'validData',
-          commStatus: busInfo.CommStatus,
-          delay: realtimeDelayData.delay,
-          destination: busInfo.Destination,
-          deviation: busInfo.Deviation,
-          direction: busInfo.Direction,
-          displayStatus: busInfo.DisplayStatus,
-          gpsStatus: busInfo.GPSStatus,
-          heading: busInfo.Heading,
-          lastStop: busInfo.LastStop,
-          lastUpdated,
-          latitude: busInfo.Latitude,
-          longitude: busInfo.Longitude,
-          name: busInfo.Name,
-          opStatus: busInfo.OpStatus,
-          routeID: busInfo.RouteId,
-          runID: busInfo.RunId,
-          speed: busInfo.Speed,
-          tripID: busInfo.TripId,
-          vehicleID: busInfo.VehicleId,
-        };
-      })(busFound);
-
-      LogUtils.log({ message: 'getTrackingResponse: validData', trackingData });
-
-      // we have tracking data for the bus
-      if (trackingData) {
-        trackingInformation.push(trackingData);
-      } else {
-        return false;
-      }
-      return true;
+  const vehicles = await fetchVehicles();
+  console.log('vehicles', vehicles);
+
+  const trackingInformation = requestData.map((data) => {
+    const { routeID, tripID } = data;
+    const vehicleData = getVehicleInformation(routeID, tripID, vehicles);
+    if (!vehicleData) {
+      LogUtils.log({ message: 'getVehicleResponse: noData', vehicleData });
+      return null;
     }
-    return false;
-  })).catch((err) => {
-    LogUtils.logErr(err, requestData, 'Tracking error');
-    throw err;
-  });
-
-  if (trackingInformation.length > 0) {
-    return trackingInformation;
-  }
+    return vehicleData;
+  }).filter(Boolean);
 
-  LogUtils.log({ message: 'getTrackingResponse: noData', trackingInformation });
-  // TODO: change this to non-dummy data once client fix is out
-  return [{
-    case: 'noData',
-    commStatus: '',
-    delay: 0,
-    destination: '',
-    deviation: 0,
-    direction: '',
-    displayStatus: '',
-    gpsStatus: 0,
-    heading: 0,
-    lastStop: '',
-    lastUpdated: 0,
-    latitude: 0,
-    longitude: 0,
-    name: '',
-    opStatus: '',
-    routeID: parseInt(requestData[0].routeID),
-    runID: 0,
-    speed: 0,
-    tripID: 0,
-    vehicleID: 0,
-  }];
+  return trackingInformation;
 }
 
 /**
@@ -146,7 +59,11 @@ async function getTrackingResponse(requestData: Object): Object {
  * @param rtf
  * @returns Object
  */
-function getDelayInformation(stopID: String, tripID: String, rtf: Object): ?Object {
+function getDelayInformation(
+  stopID: ?String,
+  tripID: ?String,
+  rtf: ?Object,
+): ?Object {
   // rtf param ensures the realtimeFeed doesn't update in the middle of execution
   // if invalid params or the trip is inactive
   if (!stopID
@@ -172,8 +89,32 @@ function getDelayInformation(stopID: String, tripID: String, rtf: Object): ?Obje
   };
 }
 
+function getVehicleInformation(
+  routeID: ?String,
+  tripID: ?String,
+  vehicles: ?Object,
+): ?Object {
+  // vehicles param ensures the vehicle tracking information doesn't update in
+  // the middle of execution
+  if (!routeID
+    || !tripID
+    || !vehicles
+    || vehicles === {}) {
+    LogUtils.log({
+      category: 'getVehicleInformation NULL',
+      routeID,
+      tripID,
+    });
+    return null;
+  }
+
+  return Object.values(vehicles).find(v => v.routeID === routeID && v.tripID === tripID);
+}
+
 export default {
   fetchRTF,
+  fetchVehicles,
   getDelayInformation,
+  getVehicleInformation,
   getTrackingResponse,
 };