Don't consider a vehicle "invalid" when on a shuttle run (#546)

Add an is_shuttle property to Vehicle.
mbta · Mar 31, 2020 · b260612 · b260612
1 parent d6cdfd9
commit b260612
Show file tree

Hide file tree

Showing 37 changed files with 132 additions and 52 deletions.
diff --git a/assets/src/components/propertiesList.tsx b/assets/src/components/propertiesList.tsx
@@ -2,7 +2,7 @@ import React from "react"
 import { intersperseString } from "../helpers/array"
 import { filterToAlphanumeric } from "../models/searchQuery"
 import { formattedRunNumber } from "../models/shuttle"
-import { isShuttle, isVehicle } from "../models/vehicle"
+import { isVehicle } from "../models/vehicle"
 import { Ghost, Vehicle, VehicleOrGhost } from "../realtime"
 import { formattedTime, formattedTimeDiff, now } from "../util/dateTime"
 
@@ -29,9 +29,10 @@ const vehicleProperties = (vehicle: Vehicle): Property[] => {
   return [
     {
       label: "Run",
-      value: isShuttle(vehicle)
-        ? formattedRunNumber(vehicle)
-        : runId || "Not Available",
+      value:
+        isVehicle(vehicle) && vehicle.isShuttle
+          ? formattedRunNumber(vehicle)
+          : runId || "Not Available",
     },
     {
       label: "Vehicle",

diff --git a/assets/src/components/propertiesPanel/header.tsx b/assets/src/components/propertiesPanel/header.tsx
@@ -8,11 +8,7 @@ import {
   LadderDirections,
   VehicleDirection,
 } from "../../models/ladderDirection"
-import {
-  isShuttle,
-  isVehicle,
-  shouldShowHeadwayDiagram,
-} from "../../models/vehicle"
+import { isVehicle, shouldShowHeadwayDiagram } from "../../models/vehicle"
 import {
   drawnStatus,
   humanReadableScheduleAdherence,
@@ -123,7 +119,7 @@ const Header = ({ vehicle, route }: Props) => {
           <HeadwayTarget vehicle={vehicle} />
         ) : (
           isVehicle(vehicle) &&
-          !isShuttle(vehicle) && <ScheduleAdherence vehicle={vehicle} />
+          !vehicle.isShuttle && <ScheduleAdherence vehicle={vehicle} />
         )}
       </div>
       <CloseButton onClick={hideMe} />

diff --git a/assets/src/components/propertiesPanel/vehiclePropertiesPanel.tsx b/assets/src/components/propertiesPanel/vehiclePropertiesPanel.tsx
@@ -2,7 +2,7 @@ import React, { useState } from "react"
 import useInterval from "../../hooks/useInterval"
 import { useTripShape } from "../../hooks/useShapes"
 import { hasBlockWaiver } from "../../models/blockWaiver"
-import { isShuttle, shouldShowHeadwayDiagram } from "../../models/vehicle"
+import { shouldShowHeadwayDiagram } from "../../models/vehicle"
 import { DataDiscrepancy, Vehicle } from "../../realtime"
 import { Route, Shape } from "../../schedule"
 import Map from "../map"
@@ -56,7 +56,7 @@ const Location = ({ vehicle }: { vehicle: Vehicle }) => {
     <div className="m-vehicle-properties-panel__location">
       <div className="m-properties-list__property-label">Next Stop</div>
       <div className="m-properties-list__property-value">
-        {isOffCourse || isShuttle(vehicle) ? (
+        {isOffCourse || vehicle.isShuttle ? (
           <NotAvailable />
         ) : (
           <>{stopStatus.stopName}</>

diff --git a/assets/src/components/routeVariantName.tsx b/assets/src/components/routeVariantName.tsx
@@ -1,9 +1,9 @@
 import React from "react"
-import { isShuttle, isVehicle } from "../models/vehicle"
+import { isVehicle } from "../models/vehicle"
 import { VehicleOrGhost } from "../realtime"
 
 export const RouteVariantName = ({ vehicle }: { vehicle: VehicleOrGhost }) => {
-  if (isVehicle(vehicle) && isShuttle(vehicle)) {
+  if (isVehicle(vehicle) && vehicle.isShuttle) {
     return <div className="m-route-variant-name">Shuttle</div>
   }
 

diff --git a/assets/src/models/vehicle.ts b/assets/src/models/vehicle.ts
@@ -13,9 +13,6 @@ export const isGhost = (
 export const isLateVehicleIndicator = ({ id }: Ghost): boolean =>
   id.startsWith("ghost-incoming-")
 
-export const isShuttle = (vehicle: Vehicle): boolean =>
-  (vehicle.runId || "").startsWith("999")
-
 export const isRecentlyLoggedOn = (vehicleOrGhost: VehicleOrGhost): boolean => {
   if (isGhost(vehicleOrGhost) || !vehicleOrGhost.operatorLogonTime) {
     return false

diff --git a/assets/src/models/vehicleData.ts b/assets/src/models/vehicleData.ts
@@ -45,6 +45,7 @@ export interface VehicleData {
   previous_vehicle_id: string
   schedule_adherence_secs: number
   scheduled_headway_secs: number
+  is_shuttle: boolean
   is_off_course: boolean
   layover_departure_time: number | null
   block_is_active: boolean
@@ -136,6 +137,7 @@ export const vehicleFromData = (vehicleData: VehicleData): Vehicle => ({
   previousVehicleId: vehicleData.previous_vehicle_id,
   scheduleAdherenceSecs: vehicleData.schedule_adherence_secs,
   scheduledHeadwaySecs: vehicleData.scheduled_headway_secs,
+  isShuttle: vehicleData.is_shuttle,
   isOffCourse: vehicleData.is_off_course,
   layoverDepartureTime: vehicleData.layover_departure_time,
   blockIsActive: vehicleData.block_is_active,

diff --git a/assets/src/models/vehicleStatus.ts b/assets/src/models/vehicleStatus.ts
@@ -1,6 +1,6 @@
 import featureIsEnabled from "../laboratoryFeatures"
 import { Vehicle, VehicleOrGhost } from "../realtime.d"
-import { isGhost, isShuttle } from "./vehicle"
+import { isGhost, isVehicle } from "./vehicle"
 
 /** Where a vehicle is relative to its schedule.
  * Swiftly assigns this to all vehicles.
@@ -39,7 +39,7 @@ export const drawnStatus = (vehicleOrGhost: VehicleOrGhost): DrawnStatus => {
   }
   const vehicle = vehicleOrGhost
 
-  if (isShuttle(vehicle)) {
+  if (isVehicle(vehicle) && vehicle.isShuttle) {
     return "plain"
   }
 

diff --git a/assets/src/realtime.d.ts b/assets/src/realtime.d.ts
@@ -71,6 +71,7 @@ export interface Vehicle {
   previousVehicleId: string
   scheduleAdherenceSecs: number
   scheduledHeadwaySecs: number
+  isShuttle: boolean
   isOffCourse: boolean
   layoverDepartureTime: number | null
   blockIsActive: boolean

diff --git a/assets/src/settings.ts b/assets/src/settings.ts
@@ -1,4 +1,4 @@
-import { isShuttle, isVehicle } from "./models/vehicle"
+import { isVehicle } from "./models/vehicle"
 import { VehicleOrGhost } from "./realtime"
 
 export enum VehicleLabelSetting {
@@ -20,6 +20,6 @@ export const vehicleLabelSetting = (
   settings: Settings,
   vehicle: VehicleOrGhost
 ): VehicleLabelSetting =>
-  isVehicle(vehicle) && isShuttle(vehicle)
+  isVehicle(vehicle) && vehicle.isShuttle
     ? settings.shuttleVehicleLabel
     : settings.ladderVehicleLabel
diff --git a/assets/tests/components/incomingBox.test.tsx b/assets/tests/components/incomingBox.test.tsx
@@ -43,6 +43,7 @@ describe("IncomingBox", () => {
       previousVehicleId: "y0620",
       scheduleAdherenceSecs: 0,
       scheduledHeadwaySecs: 420,
+      isShuttle: false,
       isOffCourse: false,
       layoverDepartureTime: 1576091880,
       blockIsActive: true,

diff --git a/assets/tests/components/ladder.test.tsx b/assets/tests/components/ladder.test.tsx
@@ -50,6 +50,7 @@ describe("ladder", () => {
         previousVehicleId: "v2",
         scheduleAdherenceSecs: 0,
         scheduledHeadwaySecs: 120,
+        isShuttle: false,
         isOffCourse: false,
         layoverDepartureTime: null,
         blockIsActive: true,
@@ -89,6 +90,7 @@ describe("ladder", () => {
         previousVehicleId: "v2",
         scheduleAdherenceSecs: 0,
         scheduledHeadwaySecs: 120,
+        isShuttle: false,
         isOffCourse: false,
         layoverDepartureTime: null,
         blockIsActive: true,
@@ -140,6 +142,7 @@ describe("ladder", () => {
         previousVehicleId: "v2",
         scheduleAdherenceSecs: 0,
         scheduledHeadwaySecs: 120,
+        isShuttle: false,
         isOffCourse: false,
         layoverDepartureTime: null,
         blockIsActive: true,
@@ -241,6 +244,7 @@ describe("ladder", () => {
         previousVehicleId: "v2",
         scheduleAdherenceSecs: 0,
         scheduledHeadwaySecs: 120,
+        isShuttle: false,
         isOffCourse: false,
         layoverDepartureTime: null,
         blockIsActive: false,
@@ -280,6 +284,7 @@ describe("ladder", () => {
         previousVehicleId: "v2",
         scheduleAdherenceSecs: 0,
         scheduledHeadwaySecs: 120,
+        isShuttle: false,
         isOffCourse: false,
         layoverDepartureTime: null,
         blockIsActive: true,
@@ -355,6 +360,7 @@ describe("ladder", () => {
         previousVehicleId: "v2",
         scheduleAdherenceSecs: 0,
         scheduledHeadwaySecs: 120,
+        isShuttle: false,
         isOffCourse: false,
         layoverDepartureTime: null,
         blockIsActive: true,
@@ -429,6 +435,7 @@ describe("ladder", () => {
         previousVehicleId: "v2",
         scheduleAdherenceSecs: 0,
         scheduledHeadwaySecs: 120,
+        isShuttle: false,
         isOffCourse: false,
         layoverDepartureTime: null,
         blockIsActive: true,
@@ -468,6 +475,7 @@ describe("ladder", () => {
         previousVehicleId: "v2",
         scheduleAdherenceSecs: 0,
         scheduledHeadwaySecs: 120,
+        isShuttle: false,
         isOffCourse: false,
         layoverDepartureTime: null,
         blockIsActive: true,
@@ -568,6 +576,7 @@ describe("ladder", () => {
       previousVehicleId: "",
       scheduleAdherenceSecs: 0,
       scheduledHeadwaySecs: 120,
+      isShuttle: false,
       isOffCourse: false,
       layoverDepartureTime: null,
       blockIsActive: true,
@@ -652,6 +661,7 @@ describe("ladder", () => {
       previousVehicleId: "v2",
       scheduleAdherenceSecs: 0,
       scheduledHeadwaySecs: 120,
+      isShuttle: false,
       isOffCourse: false,
       layoverDepartureTime: null,
       blockIsActive: true,
@@ -742,6 +752,7 @@ describe("ladder", () => {
         previousVehicleId: "v2",
         scheduleAdherenceSecs: 0,
         scheduledHeadwaySecs: 120,
+        isShuttle: false,
         isOffCourse: false,
         layoverDepartureTime: null,
         blockIsActive: true,
@@ -805,6 +816,7 @@ describe("ladder", () => {
         previousVehicleId: "v2",
         scheduleAdherenceSecs: 0,
         scheduledHeadwaySecs: 120,
+        isShuttle: false,
         isOffCourse: false,
         layoverDepartureTime: null,
         blockIsActive: true,
@@ -874,6 +886,7 @@ describe("ladder", () => {
       previousVehicleId: "v2",
       scheduleAdherenceSecs: 0,
       scheduledHeadwaySecs: 120,
+      isShuttle: false,
       isOffCourse: true,
       layoverDepartureTime: null,
       blockIsActive: true,

diff --git a/assets/tests/components/layoverBox.test.tsx b/assets/tests/components/layoverBox.test.tsx
@@ -33,6 +33,7 @@ const vehicles: Vehicle[] = [
     previousVehicleId: "v2",
     scheduleAdherenceSecs: 0,
     scheduledHeadwaySecs: 120,
+    isShuttle: false,
     isOffCourse: false,
     layoverDepartureTime: 1000002,
     blockIsActive: true,
@@ -72,6 +73,7 @@ const vehicles: Vehicle[] = [
     previousVehicleId: "v2",
     scheduleAdherenceSecs: 0,
     scheduledHeadwaySecs: 120,
+    isShuttle: false,
     isOffCourse: false,
     layoverDepartureTime: 1000001,
     blockIsActive: true,

diff --git a/assets/tests/components/map.test.tsx b/assets/tests/components/map.test.tsx
@@ -44,6 +44,7 @@ const vehicle: Vehicle = {
   previousVehicleId: "v2",
   scheduleAdherenceSecs: 0,
   scheduledHeadwaySecs: 120,
+  isShuttle: false,
   isOffCourse: false,
   layoverDepartureTime: null,
   blockIsActive: false,

diff --git a/assets/tests/components/propertiesList.test.tsx b/assets/tests/components/propertiesList.test.tsx
@@ -35,6 +35,7 @@ const vehicle: Vehicle = {
   previousVehicleId: "v2",
   scheduleAdherenceSecs: 0,
   scheduledHeadwaySecs: 120,
+  isShuttle: false,
   isOffCourse: false,
   layoverDepartureTime: null,
   blockIsActive: false,

diff --git a/assets/tests/components/propertiesPanel.test.tsx b/assets/tests/components/propertiesPanel.test.tsx
@@ -47,6 +47,7 @@ const vehicle: Vehicle = {
   previousVehicleId: "v2",
   scheduleAdherenceSecs: 0,
   scheduledHeadwaySecs: 120,
+  isShuttle: false,
   isOffCourse: false,
   layoverDepartureTime: null,
   blockIsActive: false,

diff --git a/assets/tests/components/propertiesPanel/header.test.tsx b/assets/tests/components/propertiesPanel/header.test.tsx
@@ -35,6 +35,7 @@ const vehicle: Vehicle = {
   previousVehicleId: "v2",
   scheduleAdherenceSecs: 0,
   scheduledHeadwaySecs: 120,
+  isShuttle: false,
   isOffCourse: false,
   layoverDepartureTime: null,
   blockIsActive: false,
@@ -145,7 +146,7 @@ describe("Header", () => {
   test("renders for a shuttle", () => {
     const shuttleVehicle: Vehicle = {
       ...vehicle,
-      runId: "999-0555",
+      isShuttle: true,
     }
 
     const tree = renderer

diff --git a/assets/tests/components/propertiesPanel/headwayDiagram.test.tsx b/assets/tests/components/propertiesPanel/headwayDiagram.test.tsx
@@ -29,6 +29,7 @@ const vehicle: Vehicle = {
   previousVehicleId: "y1750",
   scheduleAdherenceSecs: -305,
   scheduledHeadwaySecs: 480,
+  isShuttle: false,
   isOffCourse: false,
   layoverDepartureTime: null,
   blockIsActive: true,
@@ -104,6 +105,7 @@ describe("HeadwayDiagram", () => {
       previousVehicleId: "y1798",
       scheduleAdherenceSecs: 408,
       scheduledHeadwaySecs: 540,
+      isShuttle: false,
       isOffCourse: false,
       layoverDepartureTime: null,
       blockIsActive: true,
@@ -161,6 +163,7 @@ describe("HeadwayDiagram", () => {
       previousVehicleId: "y1894",
       scheduleAdherenceSecs: 313,
       scheduledHeadwaySecs: 600,
+      isShuttle: false,
       isOffCourse: false,
       layoverDepartureTime: null,
       blockIsActive: true,

diff --git a/assets/tests/components/propertiesPanel/vehiclePropertiesPanel.test.tsx b/assets/tests/components/propertiesPanel/vehiclePropertiesPanel.test.tsx
@@ -35,6 +35,7 @@ const vehicle: Vehicle = {
   previousVehicleId: "v2",
   scheduleAdherenceSecs: 0,
   scheduledHeadwaySecs: 120,
+  isShuttle: false,
   isOffCourse: false,
   layoverDepartureTime: null,
   blockIsActive: false,
@@ -148,6 +149,7 @@ describe("VehiclePropertiesPanel", () => {
     const shuttleVehicle: Vehicle = {
       ...vehicle,
       runId: "999-0555",
+      isShuttle: true,
     }
 
     const tree = renderer

diff --git a/assets/tests/components/routeLadder.test.tsx b/assets/tests/components/routeLadder.test.tsx
@@ -45,6 +45,7 @@ const vehicles: Vehicle[] = [
     previousVehicleId: "v2",
     scheduleAdherenceSecs: 0,
     scheduledHeadwaySecs: 120,
+    isShuttle: false,
     isOffCourse: false,
     layoverDepartureTime: null,
     blockIsActive: true,
@@ -84,6 +85,7 @@ const vehicles: Vehicle[] = [
     previousVehicleId: "v2",
     scheduleAdherenceSecs: 0,
     scheduledHeadwaySecs: 120,
+    isShuttle: false,
     isOffCourse: false,
     layoverDepartureTime: null,
     blockIsActive: true,
@@ -382,6 +384,7 @@ describe("routeLadder", () => {
       previousVehicleId: "v2",
       scheduleAdherenceSecs: 0,
       scheduledHeadwaySecs: 120,
+      isShuttle: false,
       isOffCourse: false,
       layoverDepartureTime: null,
       blockIsActive: true,

diff --git a/assets/tests/components/routeVariantName.test.tsx b/assets/tests/components/routeVariantName.test.tsx
@@ -25,6 +25,7 @@ const vehicle: Vehicle = {
   previousVehicleId: "v2",
   scheduleAdherenceSecs: 0,
   scheduledHeadwaySecs: 120,
+  isShuttle: false,
   isOffCourse: false,
   layoverDepartureTime: null,
   blockIsActive: false,
@@ -91,7 +92,7 @@ describe("RouteVariantName", () => {
   test("renders a static label for a shuttle", () => {
     const testVehicle: Vehicle = {
       ...vehicle,
-      runId: "999-0604",
+      isShuttle: true,
     }
 
     const wrapper = shallow(<RouteVariantName vehicle={testVehicle} />)

diff --git a/assets/tests/components/searchPage.test.tsx b/assets/tests/components/searchPage.test.tsx
@@ -37,6 +37,7 @@ const vehicle: Vehicle = {
   previousVehicleId: "v2",
   scheduleAdherenceSecs: 0,
   scheduledHeadwaySecs: 120,
+  isShuttle: false,
   isOffCourse: false,
   layoverDepartureTime: null,
   blockIsActive: false,