-
Notifications
You must be signed in to change notification settings - Fork 72
[macOS] Properly handle cases where lldb-dap
cannot be found with xcrun
#1119
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
Merged
matthewbastien
merged 10 commits into
swiftlang:main
from
matthewbastien:failed-to-find-lldb-dap
Oct 4, 2024
Merged
[macOS] Properly handle cases where lldb-dap
cannot be found with xcrun
#1119
matthewbastien
merged 10 commits into
swiftlang:main
from
matthewbastien:failed-to-find-lldb-dap
Oct 4, 2024
Conversation
This file contains hidden or 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
award999
reviewed
Oct 3, 2024
michael-weng
reviewed
Oct 3, 2024
award999
reviewed
Oct 4, 2024
michael-weng
reviewed
Oct 4, 2024
plemarquand
approved these changes
Oct 4, 2024
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.
Some users were seeing the extension fail to activate due to
lldb-dap
not being found in the toolchain. I've tracked this down to three underlying issues with the extension:DebugAdapter.verifyDebugAdapterExists()
function was awaited on extension startupSwiftToolchain.getLLDB()
andSwiftToolchain.getLLDBDebugAdapter()
functions can throw errors when the executables are not found. This was not being caught properly byDebugAdapter.verifyDebugAdapterExists()
.DebugAdapter.adapterName
andDebugAdapter.getAdapterType()
that can cause them to return different debug adapters under certain circumstances.The
DebugAdapter.verifyDebugAdapterExists()
will now catch errors thrown by the SwiftToolchain when finding executables and the extension activation now properly runs this check in the background. I've also updated the docstrings forgetLLDB()
andgetLLDBDebugAdapter()
to make it more obvious that they can throw and added some tests in the hopes that this won't happen again.I've replaced the
DebugAdapter.adapterName
property andDebugAdapter.getAdapterType()
function with a singleDebugAdapter.getLaunchConfigType()
function. This will hopefully reduce any further issues with adapter mismatches from happening in the future.I've added
mock-fs
as a dependency now since these new tests rely on a lot of file system checks and it's easier to mock thefs
module this way. The documentation for writing tests has been updated to reflect this.Related issues: #1069 #1077