chore: run tasks with Mix.shell().cmd/1 to avoid state issues

Author: zachdaniel

lib/igniter.ex

@@ -2119,10 +2119,6 @@ defmodule Igniter do
     end)
   end
 
-  # Runs queued tasks with tracking. Builds a list of all tasks to run; as each
-  # completes successfully it is removed from the pending list. On compile or
-  # runtime failure, writes a concise error log (reason + tasks that did not run)
-  # and re-raises.
   @doc false
   def run_queued_tasks_with_tracking(tasks) when is_list(tasks) do
     sort_tasks_with_delayed_last(tasks) |> run_next()
@@ -2131,41 +2127,29 @@ defmodule Igniter do
   defp run_next([]), do: :ok
 
   defp run_next([{task_name, args} | rest]) do
-    Mix.Task.reenable(task_name)
-    Enum.each(["compile", "app.config", "loadpaths"], &Mix.Task.reenable/1)
-    Mix.Task.run(task_name, args)
-    run_next(rest)
-  rescue
-    e ->
-      tasks_not_run = Enum.map([{task_name, args} | rest], &format_task_for_log/1)
-      error_log = format_task_failure_log(e, task_name, args, tasks_not_run)
-      Mix.shell().error("\n" <> error_log <> "\n")
-      reraise e, __STACKTRACE__
-  end
-
-  defp format_task_for_log({task_name, []}), do: "mix #{task_name}"
-  defp format_task_for_log({task_name, args}), do: "mix #{task_name} #{Enum.join(args, " ")}"
-
-  defp format_task_failure_log(exception, task_name, args, tasks_not_run) do
-    kind = failure_kind(exception)
     task_invocation = format_task_for_log({task_name, args})
-    reason = Exception.message(exception)
-
-    lines = [
-      "Task failed (#{kind}): #{task_invocation}",
-      "Reason: #{reason}",
-      "",
-      "Tasks that did not run:",
-      Enum.map_join(tasks_not_run, "\n", fn t -> "  • " <> t end)
-    ]
 
-    Enum.join(lines, "\n")
-  end
+    case Mix.shell().cmd("mix #{task_name} #{Enum.join(args, " ")}") do
+      0 ->
+        run_next(rest)
+
+      exit_code ->
+        tasks_not_run = Enum.map([{task_name, args} | rest], &format_task_for_log/1)
 
-  defp failure_kind(%CompileError{}), do: "compile error"
-  defp failure_kind(%Mix.Error{}), do: "mix error"
+        error_log =
+          [
+            "Task failed (exit code #{exit_code}): #{task_invocation}",
+            "",
+            "Tasks that did not run:",
+            Enum.map_join(tasks_not_run, "\n", fn t -> "  • " <> t end)
+          ]
+          |> Enum.join("\n")
 
-  defp failure_kind(_) do
-    "runtime error"
+        Mix.shell().error("\n" <> error_log <> "\n")
+        raise Mix.Error, message: "#{task_invocation} exited with code #{exit_code}"
+    end
   end
+
+  defp format_task_for_log({task_name, []}), do: "mix #{task_name}"
+  defp format_task_for_log({task_name, args}), do: "mix #{task_name} #{Enum.join(args, " ")}"
 end

test/igniter_test.exs

@@ -371,6 +371,11 @@ defmodule IgniterTest do
   end
 
   describe "run_queued_tasks_with_tracking/1" do
+    setup do
+      Mix.shell(Mix.Shell.Process)
+      on_exit(fn -> Mix.shell(Mix.Shell.IO) end)
+    end
+
     test "empty list returns :ok and runs nothing" do
       assert :ok == Igniter.run_queued_tasks_with_tracking([])
     end
@@ -393,29 +398,19 @@ defmodule IgniterTest do
       assert :ok == Igniter.run_queued_tasks_with_tracking(tasks_with_delayed)
     end
 
-    test "on task failure, logs concise error with reason and tasks that did not run, then re-raises" do
-      output =
-        capture_io(:stderr, fn ->
-          try do
-            Igniter.run_queued_tasks_with_tracking([
-              {"nonexistent.task.xyz.igniter_test", []},
-              {"compile", []}
-            ])
-          rescue
-            _ -> :rescued
-          end
-        end)
+    test "on task failure, logs error with task info and tasks that did not run, then raises" do
+      assert_raise Mix.Error, fn ->
+        Igniter.run_queued_tasks_with_tracking([
+          {"nonexistent.task.xyz.igniter_test", []},
+          {"compile", []}
+        ])
+      end
 
+      assert_received {:mix_shell, :error, [output]}
       assert output =~ "Task failed"
       assert output =~ "Tasks that did not run"
       assert output =~ "mix nonexistent.task.xyz.igniter_test"
       assert output =~ "mix compile"
     end
-
-    test "on task failure, exception is re-raised" do
-      assert_raise Mix.NoTaskError, fn ->
-        Igniter.run_queued_tasks_with_tracking([{"nonexistent.task.xyz.igniter_test", []}])
-      end
-    end
   end
 end