From d71f45f5324e36ff9adb2d4a1cc27bfe0706e917 Mon Sep 17 00:00:00 2001 From: David Wilson Date: Thu, 5 Nov 2026 14:38:34 +0200 Subject: [PATCH] Report evaluate compile errors in the response instead of stderr Since Elixir 1.15, Code.eval_string/3 prints compiler diagnostics to stderr before raising CompileError, and the CompileError itself only says "cannot compile file (errors have been logged)". A failed evaluate, such as hovering over `defmodule` while paused, therefore sent the diagnostic to the client as a stderr output event and returned an evaluateError without the actual message. Each hover added another block to the debug console. Run the evaluation inside Code.with_diagnostics/1. When it raises CompileError, use the error diagnostics as the description, so the evaluateError carries the message instead of stderr. Other diagnostics, such as warnings, are still printed, now after the evaluation returns. Fixes #1291 --- .../debug_adapter/lib/debug_adapter/server.ex | 45 ++++++++++-- apps/debug_adapter/test/debugger_test.exs | 73 +++++++++++++++++++ 2 files changed, 111 insertions(+), 7 deletions(-) diff --git a/apps/debug_adapter/lib/debug_adapter/server.ex b/apps/debug_adapter/lib/debug_adapter/server.ex index ba9d67ed7..d0ad58368 100644 --- a/apps/debug_adapter/lib/debug_adapter/server.ex +++ b/apps/debug_adapter/lib/debug_adapter/server.ex @@ -1964,13 +1964,32 @@ defmodule ElixirLS.DebugAdapter.Server do defp maybe_append_variable_type(variable, _, _value), do: variable defp evaluate_code_expression(expr, binding, env_or_opts) do - try do - env = Code.env_for_eval(env_or_opts) - {term, _bindings} = Code.eval_string(expr, binding, env) - term - catch - kind, error -> - stacktrace = prune_stacktrace(__STACKTRACE__) + # Code.eval_string prints compiler diagnostics to stderr before raising CompileError, + # which would put one block in the console for every failed hover or watch + {result, diagnostics} = + Code.with_diagnostics(fn -> + try do + env = Code.env_for_eval(env_or_opts) + {term, _bindings} = Code.eval_string(expr, binding, env) + {:ok, term} + catch + kind, error -> {:error, kind, error, __STACKTRACE__} + end + end) + + case result do + {:ok, term} -> + Enum.each(diagnostics, &Code.print_diagnostic/1) + term + + {:error, kind, error, stacktrace} -> + {error, diagnostics} = fold_error_diagnostics(error, diagnostics) + Enum.each(diagnostics, &Code.print_diagnostic/1) + + stacktrace = + stacktrace + |> prune_stacktrace() + |> Enum.reject(&match?({Code, :with_diagnostics, _, _}, &1)) {payload, stacktrace} = try do @@ -1999,6 +2018,18 @@ defmodule ElixirLS.DebugAdapter.Server do end end + defp fold_error_diagnostics(%CompileError{} = error, diagnostics) do + case Enum.split_with(diagnostics, &(&1.severity == :error)) do + {[], _} -> + {error, diagnostics} + + {errors, rest} -> + {%{error | description: Enum.map_join(errors, "\n", & &1.message)}, rest} + end + end + + defp fold_error_diagnostics(error, diagnostics), do: {error, diagnostics} + defp frame_for_eval(_paused_processes, nil), do: nil defp frame_for_eval(paused_processes, frame_id) do diff --git a/apps/debug_adapter/test/debugger_test.exs b/apps/debug_adapter/test/debugger_test.exs index c0dad5daf..954bc7885 100644 --- a/apps/debug_adapter/test/debugger_test.exs +++ b/apps/debug_adapter/test/debugger_test.exs @@ -3905,6 +3905,79 @@ defmodule ElixirLS.DebugAdapter.ServerTest do end) end + test "evaluate expression with compile error returns diagnostic without printing it", %{ + server: server + } do + in_fixture(__DIR__, "mix_project", fn -> + Server.receive_packet(server, initialize_req_(1)) + assert_receive(response(_, 1, "initialize", _)) + + stderr = + ExUnit.CaptureIO.capture_io(:stderr, fn -> + Server.receive_packet(server, gen_watch_expression_packet(1, "defmodule")) + + assert_receive( + error_response( + _, + 1, + "evaluate", + "evaluateError", + "** (CompileError) " <> message, + %{}, + _, + _ + ), + 1000 + ) + + assert message =~ ~s(undefined variable "defmodule") + refute message =~ "Code.with_diagnostics" + end) + + assert stderr == "" + end) + end + + test "evaluate expression with compile warning prints it", %{server: server} do + in_fixture(__DIR__, "mix_project", fn -> + Server.receive_packet(server, initialize_req_(1)) + assert_receive(response(_, 1, "initialize", _)) + + stderr = + ExUnit.CaptureIO.capture_io(:stderr, fn -> + Server.receive_packet(server, gen_watch_expression_packet(1, "(fn y -> 1 end).(2)")) + assert_receive(%{"body" => %{"result" => "1"}}, 1000) + end) + + assert stderr =~ ~s(variable "y" is unused) + end) + end + + test "evaluate expression with compile error prints only its warnings", %{server: server} do + in_fixture(__DIR__, "mix_project", fn -> + Server.receive_packet(server, initialize_req_(1)) + assert_receive(response(_, 1, "initialize", _)) + + stderr = + ExUnit.CaptureIO.capture_io(:stderr, fn -> + Server.receive_packet( + server, + gen_watch_expression_packet(1, "(fn y -> 1 end); defmodule") + ) + + assert_receive( + error_response(_, 1, "evaluate", "evaluateError", message, %{}, _, _), + 1000 + ) + + assert message =~ ~s(undefined variable "defmodule") + end) + + assert stderr =~ ~s(variable "y" is unused) + refute stderr =~ "undefined variable" + end) + end + test "evaluate expression which calls exit process", %{server: server} do in_fixture(__DIR__, "mix_project", fn -> Server.receive_packet(