add debug_attributes to igniter upgrader (#3905)

Author: SteffenDE

lib/phoenix_live_view/igniter/upgrade_to_1_1.ex

@@ -29,6 +29,7 @@ if Code.ensure_loaded?(Igniter) do
       end)
       |> maybe_update_reloadable_compilers()
       |> maybe_update_esbuild_config()
+      |> maybe_update_debug_config()
     end
 
     defp maybe_update_reloadable_compilers(igniter) do
@@ -242,5 +243,33 @@ if Code.ensure_loaded?(Igniter) do
         end
       )
     end
+
+    defp maybe_update_debug_config(igniter) do
+      if Igniter.Project.Config.configures_key?(
+           igniter,
+           "dev.exs",
+           :phoenix_live_view,
+           :debug_heex_annotations
+         ) do
+        if Igniter.Project.Config.configures_key?(
+             igniter,
+             "dev.exs",
+             :phoenix_live_view,
+             :debug_attributes
+           ) do
+          igniter
+        else
+          Igniter.Project.Config.configure(
+            igniter,
+            "dev.exs",
+            :phoenix_live_view,
+            :debug_attributes,
+            true
+          )
+        end
+      else
+        igniter
+      end
+    end
   end
 end

test/phoenix_live_view/igniter/upgrade_to_1_1_test.exs

@@ -393,6 +393,45 @@ defmodule Phoenix.LiveView.Igniter.UpgradeTo1_1Test do
     end
   end
 
+  describe "debug_attributes" do
+    test "adds debug_attributes when debug_heex_annotations is already set" do
+      test_project(
+        app_name: :my_app,
+        files: %{
+          "config/dev.exs" => """
+          import Config
+
+          config :phoenix_live_view,
+            enable_expensive_runtime_checks: true,
+            debug_heex_annotations: true
+          """
+        }
+      )
+      |> run_upgrade()
+      |> assert_has_patch("config/dev.exs", """
+      - |    debug_heex_annotations: true
+      + |    debug_heex_annotations: true,
+      + |    debug_attributes: true
+      """)
+    end
+
+    test "does not add debug_attributes when debug_heex_annotations is not set" do
+      test_project(
+        app_name: :my_app,
+        files: %{
+          "config/dev.exs" => """
+          import Config
+
+          config :phoenix_live_view,
+            enable_expensive_runtime_checks: true
+          """
+        }
+      )
+      |> run_upgrade()
+      |> assert_unchanged("config/dev.exs")
+    end
+  end
+
   describe "full upgrade scenario" do
     test "performs complete upgrade for a Phoenix project" do
       full_project()
@@ -409,6 +448,11 @@ defmodule Phoenix.LiveView.Igniter.UpgradeTo1_1Test do
       - |  reloadable_compilers: [:elixir, :app]
       + |  reloadable_compilers: [:phoenix_live_view, :elixir, :app]
       """)
+      |> assert_has_patch("config/dev.exs", """
+      - |    debug_heex_annotations: true
+      + |    debug_heex_annotations: true,
+      + |    debug_attributes: true
+      """)
       |> assert_has_patch("config/config.exs", """
       - |    args: ~w(js/app.js --bundle --outdir=../priv/static/assets),
       + |    args: ~w(js/app.js --bundle --outdir=../priv/static/assets --alias:@=.),
@@ -464,6 +508,10 @@ defmodule Phoenix.LiveView.Igniter.UpgradeTo1_1Test do
         config :my_app, MyAppWeb.Endpoint,
           http: [port: 4000],
           reloadable_compilers: [:elixir, :app]
+
+        config :phoenix_live_view,
+          enable_expensive_runtime_checks: true,
+          debug_heex_annotations: true
         """
       }
     )