Merge branch 'main' into kb-message-structure

lib/mbta_v3_api/alert.ex

@@ -35,6 +35,8 @@ defmodule MBTAV3API.Alert do
       :drawbridge_being_raised,
       :electrical_work,
       :fire,
+      :fire_department_activity,
+      :flooding,
       :fog,
       :freight_train_interference,
       :hazmat_condition,
@@ -168,9 +170,9 @@ defmodule MBTAV3API.Alert do
     %__MODULE__{
       id: item.id,
       active_period: Enum.map(item.attributes["active_period"], &ActivePeriod.parse/1),
-      cause: parse_cause(item.attributes["cause"]),
+      cause: parse_cause(item.attributes["cause"], :unknown_cause),
       description: item.attributes["description"],
-      effect: parse_effect(item.attributes["effect"]),
+      effect: parse_effect(item.attributes["effect"], :unknown_effect),
       effect_name: item.attributes["effect_name"],
       header: item.attributes["header"],
       informed_entity: Enum.map(item.attributes["informed_entity"], &InformedEntity.parse/1),

lib/util.ex

@@ -28,6 +28,17 @@ defmodule Util do
         "  end",
         "end",
         "",
+        "@spec parse_lifecycle(raw_lifecycle(), lifecycle()) :: lifecycle()",
+        "def parse_lifecycle(lifecycle, default) do",
+        "  case lifecycle do",
+        "    \\"NEW\\" -> :new",
+        "    \\"ONGOING\\" -> :ongoing",
+        "    \\"ONGOING_UPCOMING\\" -> :ongoing_upcoming",
+        "    \\"UPCOMING\\" -> :upcoming",
+        "    _ -> default",
+        "  end",
+        "end",
+        "",
         "@spec serialize_lifecycle(lifecycle()) :: raw_lifecycle()",
         "def serialize_lifecycle(lifecycle) do",
         "  case lifecycle do",
@@ -56,6 +67,15 @@ defmodule Util do
         "  end",
         "end",
         "",
+        "@spec parse_x(raw_x(), x()) :: x()",
+        "def parse_x(x, default) do",
+        "  case x do",
+        "    0 -> :a",
+        "    1 -> :b",
+        "    _ -> default",
+        "  end",
+        "end",
+        "",
         "@spec serialize_x(x()) :: raw_x()",
         "def serialize_x(x) do",
         "  case x do",
@@ -83,6 +103,15 @@ defmodule Util do
         end
       end
       #
+      @spec parse_a(raw_a(), a()) :: a()
+      def parse_a(a, default) do
+        case a do
+          "X" -> :x
+          nil -> :y
+          _ -> default
+        end
+      end
+      #
       @spec serialize_a(a()) :: raw_a()
       def serialize_a(a) do
         case a do
@@ -111,6 +140,7 @@ defmodule Util do
     parse_fn = :"parse_#{name}"
     serialize_fn = :"serialize_#{name}"
     method_arg = Macro.var(name, __MODULE__)
+    default_arg = Macro.var(:default, __MODULE__)
     raw_type = :"raw_#{name}"
     raw_type_name = Macro.var(raw_type, nil)
 
@@ -124,6 +154,11 @@ defmodule Util do
         clause
       end)
 
+    parse_default_clause =
+      quote do
+        _ -> unquote(default_arg)
+      end
+
     serialize_clauses =
       Enum.map(values, fn {value, raw_value} ->
         [{:->, _, _} = clause] =
@@ -135,6 +170,7 @@ defmodule Util do
       end)
 
     parse_body = {:case, [], [method_arg, [do: parse_clauses]]}
+    parse_default_body = {:case, [], [method_arg, [do: parse_clauses ++ parse_default_clause]]}
     serialize_body = {:case, [], [method_arg, [do: serialize_clauses]]}
 
     quote do
@@ -146,6 +182,11 @@ defmodule Util do
         unquote(parse_body)
       end
 
+      @spec unquote(parse_fn)(unquote(raw_type)(), unquote(name)()) :: unquote(name)()
+      def unquote(parse_fn)(unquote(method_arg), unquote(default_arg)) do
+        unquote(parse_default_body)
+      end
+
       @spec unquote(serialize_fn)(unquote(name)()) :: unquote(raw_type)()
       def unquote(serialize_fn)(unquote(method_arg)) do
         unquote(serialize_body)

test/mbta_v3_api/alert_test.exs

@@ -241,4 +241,42 @@ defmodule MBTAV3API.AlertTest do
              updated_at: ~B[2024-02-12 11:49:00]
            }
   end
+
+  test "unexpected enum values fall back" do
+    assert Alert.parse(%JsonApi.Item{
+             id: "553407",
+             attributes: %{
+               "active_period" => [
+                 %{"start" => "2024-02-12T11:49:00-05:00", "end" => "2024-02-12T14:26:40-05:00"}
+               ],
+               "cause" => "ALIENS",
+               "description" => "Description",
+               "effect" => "TELEPORTATION",
+               "header" => "Header",
+               "informed_entity" => [
+                 %{"activities" => ["BOARD", "EXIT", "RIDE"], "route" => "39", "route_type" => 3}
+               ],
+               "lifecycle" => "NEW",
+               "updated_at" => "2024-02-12T11:49:00-05:00"
+             }
+           }) == %Alert{
+             id: "553407",
+             active_period: [
+               %Alert.ActivePeriod{start: ~B[2024-02-12 11:49:00], end: ~B[2024-02-12 14:26:40]}
+             ],
+             cause: :unknown_cause,
+             description: "Description",
+             effect: :unknown_effect,
+             header: "Header",
+             informed_entity: [
+               %Alert.InformedEntity{
+                 activities: [:board, :exit, :ride],
+                 route: "39",
+                 route_type: :bus
+               }
+             ],
+             lifecycle: :new,
+             updated_at: ~B[2024-02-12 11:49:00]
+           }
+  end
 end

test/mbta_v3_api/mbta_v3_api_test.exs

@@ -1,5 +1,5 @@
 defmodule MBTAV3APITest do
-  use ExUnit.Case, async: true
+  use ExUnit.Case, async: false
 
   import Mox
   import Test.Support.Helpers

test/mbta_v3_api/stream/consumer_test.exs

@@ -1,5 +1,5 @@
 defmodule MBTAV3API.Stream.ConsumerTest do
-  use ExUnit.Case, async: true
+  use ExUnit.Case, async: false
 
   alias MBTAV3API.JsonApi
   alias MBTAV3API.Route

test/mobile_app_backend/throttler_test.exs

@@ -1,9 +1,12 @@
 defmodule MobileAppBackend.ThrottlerTest do
-  use ExUnit.Case, async: true
+  # run exclusively for more precise timing
+  use ExUnit.Case, async: false
 
   alias MobileAppBackend.Throttler
 
   @timeout 10
+  # since the timing may not be perfect
+  @window 2
 
   setup ctx do
     throttler = start_link_supervised!({Throttler, target: self(), cast: :message, ms: @timeout})
@@ -37,8 +40,8 @@ defmodule MobileAppBackend.ThrottlerTest do
   test "casts later if last cast was recent", %{throttler: throttler} do
     Throttler.request(throttler)
 
-    refute_receive {:"$gen_cast", :message}, @timeout - 1
-    assert_receive {:"$gen_cast", :message}, 2
+    refute_receive {:"$gen_cast", :message}, @timeout - @window
+    assert_receive {:"$gen_cast", :message}, 2 * @window
   end
 
   @tag last_cast_ms_ago: 0
@@ -47,8 +50,8 @@ defmodule MobileAppBackend.ThrottlerTest do
       Throttler.request(throttler)
     end
 
-    refute_receive {:"$gen_cast", :message}, @timeout - 1
-    assert_receive {:"$gen_cast", :message}, 2
+    refute_receive {:"$gen_cast", :message}, @timeout - @window
+    assert_receive {:"$gen_cast", :message}, 2 * @window
     refute_receive {:"$gen_cast", :message}, @timeout
   end
 end