Early AM Logic (#655)

* Add certainty fields to prediction struct

* pass certainty to prediction content

* Add Early AM suppression logic along with bugfix for JFK UMass top line headway paging

* Add a headway direction name for Wellington SB

* Tidying up a bit

* Cleaning some things up and implementing audio readout for generic paging

* Add new takes and adjust train announcements to maintain status quo

* Flip schedules and early am status when messages get flipped. Also clean some things up and add some documentation

* Add warn log when generic paging messages are of unequal length

* Add new unit testing

* Fix existing unit tests

* remove comment

* Fix bad merges

* Remove old file

* Remove duplicate test

* Don't flip messages when top line is empty

* Add additional comments and clean up predictions filtering logic

* Address PR comments, specifically add logic for an unhandled JFK/UMass case

* handle non-suppressed headway at JFK

* Fix unit tests

* Start filtering stopped train messages based on certainty and make filtering code more readable

* Add unit test for stopped train message filtering

* Use right certainty fields

---------

Co-authored-by: Brett Heath-Wlaz <[email protected]>

lib/content/message/predictions.ex

@@ -30,7 +30,8 @@ defmodule Content.Message.Predictions do
     width: 18,
     platform: nil,
     new_cars?: false,
-    terminal?: false
+    terminal?: false,
+    certainty: nil
   ]
 
   @type t :: %__MODULE__{
@@ -45,7 +46,8 @@ defmodule Content.Message.Predictions do
           station_code: String.t() | nil,
           zone: String.t() | nil,
           platform: Content.platform() | nil,
-          terminal?: boolean()
+          terminal?: boolean(),
+          certainty: non_neg_integer() | nil
         }
 
   @spec non_terminal(
@@ -61,6 +63,11 @@ defmodule Content.Message.Predictions do
     # e.g., North Station which is non-terminal but has trips that begin there
     predicted_time = prediction.seconds_until_arrival || prediction.seconds_until_departure
 
+    certainty =
+      if prediction.seconds_until_arrival,
+        do: prediction.arrival_certainty,
+        else: prediction.departure_certainty
+
     minutes =
       cond do
         prediction.stops_away == 0 -> :boarding
@@ -87,7 +94,8 @@ defmodule Content.Message.Predictions do
           new_cars?: prediction.new_cars?,
           station_code: station_code,
           zone: zone,
-          platform: platform
+          platform: platform,
+          certainty: certainty
         }
 
       {:error, _} ->
@@ -125,7 +133,8 @@ defmodule Content.Message.Predictions do
           direction_id: prediction.direction_id,
           width: width,
           new_cars?: prediction.new_cars?,
-          terminal?: true
+          terminal?: true,
+          certainty: prediction.departure_certainty
         }
 
       {:error, _} ->

lib/content/message/stopped_train.ex

@@ -13,11 +13,12 @@ defmodule Content.Message.StoppedTrain do
   require Logger
 
   @enforce_keys [:destination, :stops_away]
-  defstruct @enforce_keys
+  defstruct @enforce_keys ++ [:certainty]
 
   @type t :: %__MODULE__{
           destination: PaEss.destination(),
-          stops_away: non_neg_integer()
+          stops_away: non_neg_integer(),
+          certainty: non_neg_integer() | nil
         }
 
   @spec from_prediction(Predictions.Prediction.t()) :: t() | nil
@@ -32,7 +33,8 @@ defmodule Content.Message.StoppedTrain do
 
         %__MODULE__{
           destination: destination,
-          stops_away: stops_away
+          stops_away: stops_away,
+          certainty: prediction.arrival_certainty || prediction.departure_certainty
         }
 
       {:error, _} ->

lib/engine/scheduled_headways.ex

@@ -95,6 +95,13 @@ defmodule Engine.ScheduledHeadways do
     :ets.select(table_name, pattern)
   end
 
+  @spec get_first_scheduled_departure([binary]) :: nil | DateTime.t()
+  def get_first_scheduled_departure(stop_ids) do
+    get_first_last_departures(stop_ids)
+    |> Enum.map(&elem(&1, 0))
+    |> min_time()
+  end
+
   @doc "Checks if the given time is after the first scheduled stop and before the last.
   A buffer of minutes (positive) is subtracted from the first time. so that headways are
   shown for a short time before the first train."

lib/predictions/prediction.ex

@@ -1,7 +1,9 @@
 defmodule Predictions.Prediction do
   defstruct stop_id: nil,
             seconds_until_arrival: nil,
+            arrival_certainty: nil,
             seconds_until_departure: nil,
+            departure_certainty: nil,
             seconds_until_passthrough: nil,
             direction_id: nil,
             schedule_relationship: nil,
@@ -20,7 +22,9 @@ defmodule Predictions.Prediction do
   @type t :: %__MODULE__{
           stop_id: String.t(),
           seconds_until_arrival: non_neg_integer() | nil,
+          arrival_certainty: non_neg_integer() | nil,
           seconds_until_departure: non_neg_integer() | nil,
+          departure_certainty: non_neg_integer() | nil,
           seconds_until_passthrough: non_neg_integer() | nil,
           direction_id: 0 | 1,
           schedule_relationship: :scheduled | :skipped | nil,

lib/predictions/predictions.ex

@@ -96,7 +96,9 @@ defmodule Predictions.Predictions do
       stop_id: stop_time_update["stop_id"],
       direction_id: direction_id,
       seconds_until_arrival: max(0, seconds_until_arrival),
+      arrival_certainty: stop_time_update["arrival"]["uncertainty"],
       seconds_until_departure: max(0, seconds_until_departure),
+      departure_certainty: stop_time_update["departure"]["uncertainty"],
       seconds_until_passthrough: max(0, seconds_until_passthrough),
       schedule_relationship:
         translate_schedule_relationship(stop_time_update["schedule_relationship"]),

lib/signs/realtime.ex

@@ -24,7 +24,6 @@ defmodule Signs.Realtime do
     :last_departure_engine,
     :config_engine,
     :alerts_engine,
-    :current_time_fn,
     :sign_updater,
     :last_update,
     :tick_audit,
@@ -35,6 +34,7 @@ defmodule Signs.Realtime do
   defstruct @enforce_keys ++
               [
                 :headway_stop_id,
+                :current_time_fn,
                 announced_arrivals: [],
                 announced_approachings: [],
                 announced_passthroughs: [],
@@ -123,6 +123,22 @@ defmodule Signs.Realtime do
     sign_config = sign.config_engine.sign_config(sign.id)
     current_time = sign.current_time_fn.()
 
+    first_scheduled_departures =
+      case sign.source_config do
+        {top, bottom} ->
+          {
+            {sign.headway_engine.get_first_scheduled_departure(SourceConfig.sign_stop_ids(top)),
+             top.headway_destination},
+            {sign.headway_engine.get_first_scheduled_departure(
+               SourceConfig.sign_stop_ids(bottom)
+             ), bottom.headway_destination}
+          }
+
+        source ->
+          {sign.headway_engine.get_first_scheduled_departure(sign_stop_ids),
+           source.headway_destination}
+      end
+
     predictions =
       case sign.source_config do
         {top, bottom} -> {fetch_predictions(top, sign), fetch_predictions(bottom, sign)}
@@ -135,7 +151,8 @@ defmodule Signs.Realtime do
         sign,
         sign_config,
         current_time,
-        alert_status
+        alert_status,
+        first_scheduled_departures
       )
 
     sign =