Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DAP] Use cwd from launch config, not from project node #1433

Merged
merged 1 commit into from
May 26, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
72 changes: 41 additions & 31 deletions apps/els_dap/src/els_dap_general_provider.erl
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,8 @@
breakpoints := els_dap_breakpoints:breakpoints(),
hits => #{line() => non_neg_integer()},
timeout := timeout(),
mode := mode()
mode := mode(),
cwd := binary()
}.
-type bindings() :: [{varname(), term()}].
-type varname() :: atom() | string().
Expand All @@ -66,14 +67,16 @@

-spec init() -> state().
init() ->
{ok, Cwd} = file:get_cwd(),
#{
threads => #{},
launch_params => #{},
scope_bindings => #{},
breakpoints => #{},
hits => #{},
timeout => 30,
mode => undefined
mode => undefined,
cwd => els_utils:to_binary(Cwd)
}.

-spec handle_request(request(), state()) ->
Expand Down Expand Up @@ -134,10 +137,11 @@ handle_request({<<"launch">>, #{<<"cwd">> := Cwd} = Params}, State) ->
{#{}, State#{
project_node => ProjectNode,
launch_params => Params,
timeout => TimeOut
timeout => TimeOut,
cwd => Cwd
}};
{error, Error} ->
{{error, distribution_error(Error)}, State}
{{error, distribution_error(Error)}, maps:put(cwd, Cwd, State)}
end;
handle_request({<<"attach">>, Params}, State) ->
case start_distribution(Params) of
Expand Down Expand Up @@ -229,7 +233,8 @@ handle_request(
#{
project_node := ProjectNode,
breakpoints := Breakpoints0,
timeout := Timeout
timeout := Timeout,
cwd := Cwd
} = State
) ->
ensure_connected(ProjectNode, Timeout),
Expand Down Expand Up @@ -283,7 +288,7 @@ handle_request(
<<"source">> => #{
<<"path">> =>
case Verified of
true -> source(Module, ProjectNode);
true -> source(Module, ProjectNode, Cwd);
false -> <<"">>
end
}
Expand Down Expand Up @@ -512,9 +517,10 @@ handle_request({<<"disconnect">>, _Params}, State) ->
module(),
integer(),
atom(),
pid()
pid(),
binary()
) -> boolean().
evaluate_condition(Breakpt, Module, Line, ProjectNode, ThreadPid) ->
evaluate_condition(Breakpt, Module, Line, ProjectNode, ThreadPid, Cwd) ->
%% evaluate condition if exists, otherwise treat as 'true'
case Breakpt of
#{condition := CondExpr} ->
Expand All @@ -528,7 +534,7 @@ evaluate_condition(Breakpt, Module, Line, ProjectNode, ThreadPid) ->
WarnCond = unicode:characters_to_binary(
io_lib:format(
"~s:~b - Breakpoint condition evaluated to non-Boolean: ~w~n",
[source(Module, ProjectNode), Line, CondEval]
[source(Module, ProjectNode, Cwd), Line, CondEval]
)
),
els_dap_server:send_event(
Expand All @@ -550,9 +556,10 @@ evaluate_condition(Breakpt, Module, Line, ProjectNode, ThreadPid) ->
module(),
integer(),
atom(),
pid()
pid(),
binary()
) -> boolean().
evaluate_hitcond(Breakpt, HitCount, Module, Line, ProjectNode, ThreadPid) ->
evaluate_hitcond(Breakpt, HitCount, Module, Line, ProjectNode, ThreadPid, Cwd) ->
%% evaluate condition if exists, otherwise treat as 'true'
case Breakpt of
#{hitcond := HitExpr} ->
Expand All @@ -563,7 +570,7 @@ evaluate_hitcond(Breakpt, HitCount, Module, Line, ProjectNode, ThreadPid) ->
WarnHit = unicode:characters_to_binary(
io_lib:format(
"~s:~b - Breakpoint hit condition not a non-negative int: ~w~n",
[source(Module, ProjectNode), Line, HitEval]
[source(Module, ProjectNode, Cwd), Line, HitEval]
)
),
els_dap_server:send_event(
Expand All @@ -585,9 +592,10 @@ evaluate_hitcond(Breakpt, HitCount, Module, Line, ProjectNode, ThreadPid) ->
module(),
integer(),
atom(),
pid()
pid(),
binary()
) -> boolean().
check_stop(Breakpt, IsHit, Module, Line, ProjectNode, ThreadPid) ->
check_stop(Breakpt, IsHit, Module, Line, ProjectNode, ThreadPid, Cwd) ->
case Breakpt of
#{logexpr := LogExpr} ->
case IsHit of
Expand All @@ -596,7 +604,7 @@ check_stop(Breakpt, IsHit, Module, Line, ProjectNode, ThreadPid) ->
LogMessage = unicode:characters_to_binary(
io_lib:format(
"~s:~b - ~p~n",
[source(Module, ProjectNode), Line, Return]
[source(Module, ProjectNode, Cwd), Line, Return]
)
),
els_dap_server:send_event(
Expand Down Expand Up @@ -643,18 +651,19 @@ handle_info(
project_node := ProjectNode,
breakpoints := Breakpoints,
hits := Hits0,
mode := Mode0
mode := Mode0,
cwd := Cwd
} = State
) ->
?LOG_DEBUG("Int CB called. thread=~p", [ThreadPid]),
ThreadId = id(ThreadPid),
Thread = #{
pid => ThreadPid,
frames => stack_frames(ThreadPid, ProjectNode)
frames => stack_frames(ThreadPid, ProjectNode, Cwd)
},
{Module, Line} = break_module_line(ThreadPid, ProjectNode),
Breakpt = els_dap_breakpoints:type(Breakpoints, Module, Line),
Condition = evaluate_condition(Breakpt, Module, Line, ProjectNode, ThreadPid),
Condition = evaluate_condition(Breakpt, Module, Line, ProjectNode, ThreadPid, Cwd),
%% update hit count for current line if condition is true
HitCount = maps:get(Line, Hits0, 0) + 1,
Hits1 =
Expand All @@ -665,9 +674,9 @@ handle_info(
%% check if there is hit expression, if yes check along with condition
IsHit =
Condition andalso
evaluate_hitcond(Breakpt, HitCount, Module, Line, ProjectNode, ThreadPid),
evaluate_hitcond(Breakpt, HitCount, Module, Line, ProjectNode, ThreadPid, Cwd),
%% finally, either stop or log
Stop = check_stop(Breakpt, IsHit, Module, Line, ProjectNode, ThreadPid),
Stop = check_stop(Breakpt, IsHit, Module, Line, ProjectNode, ThreadPid, Cwd),
Mode1 =
case Stop of
true -> debug_stop(ThreadId);
Expand Down Expand Up @@ -713,8 +722,8 @@ inject_dap_agent(Node) ->
id(Pid) ->
erlang:phash2(Pid).

-spec stack_frames(pid(), atom()) -> #{frame_id() => frame()}.
stack_frames(Pid, Node) ->
-spec stack_frames(pid(), atom(), binary()) -> #{frame_id() => frame()}.
stack_frames(Pid, Node, Cwd) ->
{ok, Meta} = els_dap_rpc:get_meta(Node, Pid),
[{Level, {M, F, A}} | Rest] =
els_dap_rpc:meta(Node, Meta, backtrace, all),
Expand All @@ -724,11 +733,11 @@ stack_frames(Pid, Node) ->
module => M,
function => F,
arguments => A,
source => source(M, Node),
source => source(M, Node, Cwd),
line => break_line(Pid, Node),
bindings => Bindings
},
collect_frames(Node, Meta, Level, Rest, #{StackFrameId => StackFrame}).
collect_frames(Node, Cwd, Meta, Level, Rest, #{StackFrameId => StackFrame}).

-spec break_module_line(pid(), atom()) -> {module(), integer()}.
break_module_line(Pid, Node) ->
Expand All @@ -741,9 +750,9 @@ break_line(Pid, Node) ->
{_, Line} = break_module_line(Pid, Node),
Line.

-spec source(atom(), atom()) -> binary().
source(Module, Node) ->
{ok, Source0} = els_dap_rpc:file(Node, Module),
-spec source(atom(), atom(), binary()) -> binary().
source(Module, Node, Cwd) ->
{ok, Source0} = els_dap_rpc:file(Node, Module, Cwd),
Source1 = filename:absname(Source0),
els_dap_rpc:clear(Node),
unicode:characters_to_binary(Source1).
Expand Down Expand Up @@ -954,25 +963,26 @@ format_term(T) ->
]
).

-spec collect_frames(node(), pid(), pos_integer(), Backtrace, Acc) -> Acc when
-spec collect_frames(node(), binary(), pid(), pos_integer(), Backtrace, Acc) -> Acc when
Acc :: #{frame_id() => frame()},
Backtrace :: [{pos_integer(), {module(), atom(), non_neg_integer()}}].
collect_frames(_, _, _, [], Acc) ->
collect_frames(_, _, _, _, [], Acc) ->
Acc;
collect_frames(Node, Meta, Level, [{NextLevel, {M, F, A}} | Rest], Acc) ->
collect_frames(Node, Cwd, Meta, Level, [{NextLevel, {M, F, A}} | Rest], Acc) ->
case els_dap_rpc:meta(Node, Meta, stack_frame, {up, Level}) of
{NextLevel, {_, Line}, Bindings} ->
StackFrameId = erlang:unique_integer([positive]),
StackFrame = #{
module => M,
function => F,
arguments => A,
source => source(M, Node),
source => source(M, Node, Cwd),
line => Line,
bindings => Bindings
},
collect_frames(
Node,
Cwd,
Meta,
NextLevel,
Rest,
Expand Down
46 changes: 26 additions & 20 deletions apps/els_dap/src/els_dap_rpc.erl
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
clear/1,
continue/2,
eval/3,
file/2,
file/3,
get_meta/2,
halt/1,
i/2,
Expand Down Expand Up @@ -76,9 +76,10 @@ eval(Node, Input, Bindings) ->
{badrpc, Error} -> Error
end.

-spec file(node(), module()) -> {ok, file:filename()} | {error, not_found}.
file(Node, Module) ->
case file_from_module_info(Node, Module) of
-spec file(node(), module(), binary()) -> {ok, file:filename()} | {error, not_found}.
file(Node, Module, Cwd) ->
?LOG_DEBUG("Looking in Int: [~p]", [Module]),
case file_from_module_info(Node, Module, Cwd) of
{ok, FileFromInt} ->
{ok, FileFromInt};
{error, not_found} ->
Expand Down Expand Up @@ -115,8 +116,9 @@ file_from_code_server(Node, Module) ->
rpc:call(Node, filelib, find_source, [BeamFile])
end.

-spec file_from_module_info(node(), module()) -> {ok, file:filename()} | {error, not_found}.
file_from_module_info(Node, Module) ->
-spec file_from_module_info(node(), module(), binary()) ->
{ok, file:filename()} | {error, not_found}.
file_from_module_info(Node, Module, Cwd) ->
?LOG_DEBUG("Looking in Module Info: [~p]", [Module]),
CompileOpts = module_info(Node, Module, compile),
case proplists:get_value(source, CompileOpts) of
Expand All @@ -125,23 +127,27 @@ file_from_module_info(Node, Module) ->
{error, not_found};
Source ->
?LOG_DEBUG("Found in Module Info: [~p]", [Source]),
case rpc:call(Node, filelib, is_regular, [Source]) of
true ->
{ok, Cwd} = rpc:call(Node, file, get_cwd, []),
case rpc:call(Node, filelib, safe_relative_path, [Source, Cwd]) of
unsafe ->
%% File is already absolute
{ok, Source};
RelativePath ->
Joined = filename:join(Cwd, RelativePath),
?LOG_DEBUG("Composed Absolute Path as: [~p]", [Joined]),
{ok, Joined}
end;
false ->
{error, not_found}
case filelib:safe_relative_path(Source, Cwd) of
unsafe ->
%% File is already absolute
regular_file(Node, Source);
RelativePath ->
AbsolutePath = filename:join(Cwd, RelativePath),
?LOG_DEBUG("Composed Absolute Path as: [~p]", [AbsolutePath]),
regular_file(Node, AbsolutePath)
end
end.

-spec regular_file(node(), file:filename()) -> {ok, file:filename()} | {error, not_found}.
regular_file(Node, Path) ->
case rpc:call(Node, filelib, is_regular, [Path]) of
true ->
{ok, Path};
false ->
?LOG_DEBUG("File is not regular: [~p]", [Path]),
{error, not_found}
end.

-spec get_meta(node(), pid()) -> {ok, pid()}.
get_meta(Node, Pid) ->
rpc:call(Node, dbg_iserver, safe_call, [{get_meta, Pid}]).
Expand Down
27 changes: 20 additions & 7 deletions apps/els_lsp/test/els_diagnostics_SUITE.erl
Original file line number Diff line number Diff line change
Expand Up @@ -334,7 +334,7 @@ bound_var_in_pattern(_Config) ->
Source = <<"BoundVarInPattern">>,
Errors = [],
Warnings = [],
Hints = [
Hints0 = [
#{
message => <<"Bound variable in pattern: Var1">>,
range => {{5, 2}, {5, 6}}
Expand All @@ -355,13 +355,26 @@ bound_var_in_pattern(_Config) ->
message => <<"Bound variable in pattern: Var5">>,
range => {{23, 6}, {23, 10}}
}
%% erl_syntax_lib:annotate_bindings does not handle named funs
%% correctly
%% , #{ message => <<"Bound variable in pattern: New">>
%% , range => {{28, 6}, {28, 9}}}
%% , #{ message => <<"Bound variable in pattern: F">>
%% , range => {{29, 6}, {29, 9}}}
],
Hints =
case list_to_integer(erlang:system_info(otp_release)) of
Version when Version < 25 ->
Hints0;
_ ->
lists:append(
Hints0,
[
#{
message => <<"Bound variable in pattern: New">>,
range => {{28, 6}, {28, 9}}
},
#{
message => <<"Bound variable in pattern: F">>,
range => {{29, 6}, {29, 7}}
}
]
)
end,
els_test:run_diagnostics_test(Path, Source, Errors, Warnings, Hints).

-spec bound_var_in_pattern_cannot_parse(config()) -> ok.
Expand Down