Merge pull request #8 from mbta/jz-support-all-subway-terminals

feat: Add service day column to output tables; Support all subway terminals

Author: jzimbel-mbta

.github/workflows/ci.yml

@@ -69,7 +69,7 @@ jobs:
           echo "${{ github.event.pull_request.head.sha }}" > cover/PR_SHA
         if: github.event.pull_request
       - name: Upload coverage artifact
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v4
         with:
           name: elixir-lcov
           path: cover/

lib/assets/terminal_selection/main.css

@@ -0,0 +1,3 @@
+.multiselect-group-container {
+  margin-bottom: 8px;
+}

lib/assets/terminal_selection/main.js

@@ -0,0 +1,85 @@
+export function init(ctx, { terminals, groups }) {
+  ctx.importCSS("main.css");
+
+  const root = ctx.root;
+  const container = document.createElement("div");
+  container.className = "multiselect-container";
+
+  root.append(container);
+
+  const checkboxContainers = terminals.map(([id, { label, checked }]) => {
+    const inputContainer = document.createElement("div");
+
+    const inputEl = document.createElement("input");
+    inputEl.type = "checkbox";
+    inputEl.name = id;
+    inputEl.id = id;
+    inputEl.checked = checked;
+    inputEl.addEventListener("click", (_event) => {
+      ctx.pushEvent("toggle_terminal", id);
+    });
+
+    const labelEl = document.createElement("label");
+    labelEl.htmlFor = id;
+    labelEl.innerText = label;
+
+    inputContainer.append(inputEl, labelEl);
+    return inputContainer;
+  });
+
+  const groupCheckboxContainers = groups.map(([id, { label, checked, indeterminate }]) => {
+    const inputContainer = document.createElement("div");
+
+    const inputEl = document.createElement("input");
+    inputEl.type = "checkbox";
+    inputEl.name = id;
+    inputEl.id = id;
+    inputEl.checked = checked;
+    inputEl.indeterminate = indeterminate;
+    inputEl.addEventListener("click", (_event) => {
+      ctx.pushEvent("toggle_group", id);
+    });
+
+    const labelEl = document.createElement("label");
+    labelEl.htmlFor = id;
+    labelEl.innerText = label;
+
+    inputContainer.append(inputEl, labelEl);
+    return inputContainer;
+  });
+
+  const groupContainer = document.createElement("div");
+  groupContainer.className = "multiselect-group-container";
+  groupContainer.style.marginBottom = "8px";
+
+  if (groupCheckboxContainers.length > 0) {
+    const groupsHeader = document.createElement("h3");
+    groupsHeader.className = "multiselect-group-header";
+    groupsHeader.innerText = "Stop Groups";
+    const hr = document.createElement("hr");
+    groupContainer.append(groupsHeader, ...groupCheckboxContainers, hr);
+  } else {
+    groupContainer.hidden = true;
+  }
+
+  const stopsHeader = document.createElement("h3");
+  stopsHeader.className = "multiselect-stops-header";
+  stopsHeader.innerText = "Stops";
+
+  container.append(groupContainer, stopsHeader, ...checkboxContainers);
+
+  ctx.handleEvent("update", ({ terminals, groups }) => {
+    groups.forEach(([id, { checked, indeterminate }]) => {
+      const input = document.getElementById(id);
+      if (input) {
+        input.checked = checked;
+        input.indeterminate = indeterminate;
+      }
+    });
+
+    terminals.forEach(([id, { checked }]) => {
+      const input = document.getElementById(id);
+      if (input) { input.checked = checked; }
+    });
+  });
+};

lib/transit_data/glides_report/countdown_clocks_simulation.ex

@@ -2,23 +2,23 @@ defmodule TransitData.GlidesReport.CountdownClocksSimulation do
   @moduledoc "Simulates countdown clock signs."
 
   alias TransitData.GlidesReport
+  alias TransitData.GlidesReport.Terminal
 
-  @type t :: %{stop_id => GlidesReport.Sign.t()}
-
-  @type stop_id :: String.t()
+  @type t :: %{Terminal.id() => GlidesReport.Sign.t()}
 
   @type timestamp :: integer
 
   @doc """
-  Returns a set of {stop_id, timestamp} tuples, each representing an instance where
-  a predicted time (timestamp) appeared on the countdown clock for a stop (stop_id).
+  Returns a set of {terminal_id, timestamp} tuples, each representing an instance where
+  a predicted time (timestamp) appeared on the countdown clock at a terminal (terminal_id).
   """
-  @spec get_all_top_two_times(Enumerable.t(stop_id)) :: MapSet.t({stop_id, timestamp})
-  def get_all_top_two_times(stop_ids) do
-    trip_updates_for_simulation(stop_ids)
+  @spec get_all_top_two_times(Enumerable.t(Terminal.id())) ::
+          MapSet.t({Terminal.id(), timestamp})
+  def get_all_top_two_times(terminal_ids) do
+    trip_updates_for_simulation(terminal_ids)
     |> Enum.reduce(%{}, fn tr_upd, signs -> apply_trip_update(signs, tr_upd) end)
-    |> Stream.map(fn {stop_id, sign} ->
-      MapSet.new(sign.top_twos, fn timestamp -> {stop_id, timestamp} end)
+    |> Stream.map(fn {terminal_id, sign} ->
+      MapSet.new(sign.top_twos, fn timestamp -> {terminal_id, timestamp} end)
     end)
     |> Enum.reduce(MapSet.new(), &MapSet.union/2)
   end
@@ -33,20 +33,20 @@ defmodule TransitData.GlidesReport.CountdownClocksSimulation do
 
         Map.update(
           signs,
-          stop_time_update.stop_id,
+          stop_time_update.terminal_id,
           GlidesReport.Sign.new(trip_id, departure_time, timestamp),
           &GlidesReport.Sign.apply_stop_time_update(&1, trip_id, departure_time, timestamp)
         )
     end)
   end
 
-  defp trip_updates_for_simulation(stop_ids) do
+  defp trip_updates_for_simulation(terminal_ids) do
     :TripUpdates
     |> GlidesReport.Util.stream_values()
     |> Stream.map(&GlidesReport.TripUpdate.normalize_stop_ids/1)
-    # Filter each trip update's stop_time_update to just the user's selected stops.
+    # Filter each trip update's stop_time_update to just the user's selected terminals.
     # If filtered list is empty for any trip update, the trip update is removed entirely.
-    |> Stream.map(&GlidesReport.TripUpdate.filter_stops(&1, stop_ids))
+    |> Stream.map(&GlidesReport.TripUpdate.filter_terminals(&1, terminal_ids))
     |> Stream.reject(&is_nil/1)
     |> Enum.sort_by(& &1.trip_update.timestamp)
   end

lib/transit_data/glides_report/departure.ex

@@ -5,11 +5,12 @@ defmodule TransitData.GlidesReport.Departure do
   """
 
   alias TransitData.GlidesReport.Spec.Common
+  alias TransitData.GlidesReport.Terminal
   alias TransitData.GlidesReport.Util
 
   @type t :: %__MODULE__{
           trip: Common.trip_id(),
-          stop: Common.stop_id(),
+          terminal: Terminal.id(),
           timestamp: Common.timestamp(),
           # Hour part of the timestamp (in Eastern TZ)
           hour: 0..23,
@@ -19,13 +20,13 @@ defmodule TransitData.GlidesReport.Departure do
 
   @type minute :: 0..59
 
-  @enforce_keys [:trip, :stop, :timestamp, :hour, :minute]
+  @enforce_keys [:trip, :terminal, :timestamp, :hour, :minute]
   defstruct @enforce_keys
 
-  @spec new(Common.trip_id(), Common.stop_id(), Common.timestamp()) :: t()
-  def new(trip, stop, timestamp) do
+  @spec new(Common.trip_id(), Terminal.id(), Common.timestamp()) :: t()
+  def new(trip, {:terminal, _} = terminal, timestamp) do
     hour = Util.unix_timestamp_to_local_hour(timestamp)
     minute = Util.unix_timestamp_to_local_minute(timestamp)
-    %__MODULE__{trip: trip, stop: stop, timestamp: timestamp, hour: hour, minute: minute}
+    %__MODULE__{trip: trip, terminal: terminal, timestamp: timestamp, hour: hour, minute: minute}
   end
 end

lib/transit_data/glides_report/settings/filter.ex

@@ -1,23 +1,25 @@
 defmodule TransitData.GlidesReport.Settings.Filter do
   @moduledoc "User-selected filtering settings."
 
+  alias TransitData.GlidesReport.Terminal
+
   @type t :: %__MODULE__{
-          # A set of parent stop IDs
-          stop_ids: MapSet.t(String.t()),
+          # A set of terminal IDs
+          terminal_ids: MapSet.t(Terminal.id()),
           limit_to_next_2_predictions: boolean,
           min_advance_notice_sec: pos_integer | nil
         }
 
   defstruct [
-    :stop_ids,
+    :terminal_ids,
     :limit_to_next_2_predictions,
     :min_advance_notice_sec
   ]
 
-  @spec new(MapSet.t(String.t()), boolean, pos_integer | nil) :: t()
-  def new(stop_ids, limit_to_next_2_predictions, min_advance_notice) do
+  @spec new(MapSet.t(Terminal.id()), boolean, pos_integer | nil) :: t()
+  def new(terminal_ids, limit_to_next_2_predictions, min_advance_notice) do
     %__MODULE__{
-      stop_ids: stop_ids,
+      terminal_ids: terminal_ids,
       limit_to_next_2_predictions: limit_to_next_2_predictions,
       min_advance_notice_sec:
         case min_advance_notice do

lib/transit_data/glides_report/sign.ex

@@ -1,5 +1,5 @@
 defmodule TransitData.GlidesReport.Sign do
-  @moduledoc "Simulates a countdown clock at one platform (child stop ID)."
+  @moduledoc "Simulates a countdown clock at one terminal."
 
   @type t :: %__MODULE__{
           predictions: list({trip_id :: String.t(), departure_time :: integer}),

lib/transit_data/glides_report/spec/trip_update.ex

@@ -6,6 +6,7 @@ defmodule TransitData.GlidesReport.Spec.TripUpdate do
   """
 
   alias TransitData.GlidesReport.Spec.Common
+  alias TransitData.GlidesReport.Terminal
 
   @type t :: {key, value}
 
@@ -27,9 +28,9 @@ defmodule TransitData.GlidesReport.Spec.TripUpdate do
               list(%{
                 departure: %{time: Common.timestamp()},
                 # A child stop ID initially, but we convert it to the
-                # parent stop ID of the relevant terminal by calling
+                # ID of the relevant terminal by calling
                 # GlidesReport.TripUpdate.normalize_stop_id/1 on it.
-                stop_id: Common.stop_id()
+                terminal_id: Terminal.id()
               }),
             trip: %{trip_id: Common.trip_id()}
           }

lib/transit_data/glides_report/spec/vehicle_position.ex

@@ -6,6 +6,7 @@ defmodule TransitData.GlidesReport.Spec.VehiclePosition do
   """
 
   alias TransitData.GlidesReport.Spec.Common
+  alias TransitData.GlidesReport.Terminal
 
   @type t :: {key, value}
 
@@ -19,9 +20,9 @@ defmodule TransitData.GlidesReport.Spec.VehiclePosition do
             # "IN_TRANSIT_TO" | "STOPPED_AT" | "INCOMING_AT"
             current_status: String.t(),
             # A child stop ID initially, but we convert it to the
-            # parent stop ID of the relevant terminal by calling
+            # ID of the relevant terminal by calling
             # GlidesReport.VehiclePosition.normalize_stop_id/1 on it.
-            stop_id: Common.stop_id(),
+            terminal_id: Terminal.id(),
             timestamp: Common.timestamp(),
             trip: %{
               trip_id: Common.trip_id()