[DAP] Prioritize information from module_info when available #1421
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
TheGeorge
approved these changes
Feb 21, 2023
apps/els_dap/src/els_dap_rpc.erl
Outdated
| {ok, Joined} | ||
| end; | ||
| false -> | ||
| %% Build is not hermetic |
There was a problem hiding this comment.
it might be hermetic, e.g. with +deterministic you get only the base name and is_regular will fail.
There was a problem hiding this comment.
When I tried the +determinsitc option on OTP 25 I didn't get a source entry at all, so that case would be handled in the undefined clause above. But I can remove the comment.
zengjinc
pushed a commit
to zengjinc/erlang_ls
that referenced
this pull request
Jun 12, 2023
…ls#1421) * [DAP] Cleanup logic around source path extraction * [DAP] Prefer source from module_info/compile if available * [DAP] Add logging, prefer module_info if available * [DAP] Remove un-necessary (and maybe misleading) comment
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Certain build systems (most notoriously Buck2) store build artifacts (including a copy of the source files) in custom folders (e.g.
buck-outin Buck2). This can lead to an incorrect path to be returned by the debugger to the client whenever a breakpoint triggers. In turn, this result in the editor opening a buffer from the build system custom folder rather than the original source file and confusion among the users.This PR changes the logic how the location of source files is identified. The current logic is:
compileinfo frommodule_info.The
module_infois supposed to contain the most accurate information, but - in the case of non hermetic builds - it can contain a path to a non-existing file (e.g. if the code was built on a machine and ported to a different one). That's the main reason the current logic looks like the above (see this PR for context).Instead:
compileinfo frommodule_infopoints to a regular fileThe logic has been refactored into separate functions to ease reading. Debug logs have also been added to simplify eventual troubleshooting.