Avoid blocking folder addition on package loading #1422
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
When a folder is added to a VSCode workspace we perform a `swift package describe` to load information about the package. This operation must complete before the folder is added to the `workspaceContext`, which prevents the user from taking many actions in the extension that could be made available right away. A `swift package describe` operation can potentially take a good amount of time if package resolution has not been performed. Work around this limitation by wrapping the data pulled from this `package describe` behind promises, allowing clients to wait for package resolution to complete only if they need information that is gated by it. Issue: swiftlang#1250
plemarquand
force-pushed
the
non-blocking-folder-resolution
branch
from
e4cc8c9 to
fa56bbf
Compare
plemarquand
requested review from
adam-fowler,
0xTim and
award999
as code owners
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.
When a folder is added to a VSCode workspace the extension performs a
swift package describeto load information about the package. This operation must complete before the folder is added to theworkspaceContext. This prevents the user from taking many actions in the extension that could be made available right away. Aswift package describeoperation can potentially take a good amount of time if package resolution has not yet been performed.Work around this limitation by wrapping the data pulled from this
package describebehind promises, allowing clients to wait for package resolution to complete only if they need information that is gated by it.This was tested with a large project (https://github.com/vapor/penny-bot) and I noticed the time until defined build tasks were made available improved by about ~7-10 seconds on a fresh open with an up to date .build folder. This is even faster on fresh checkout.
Issue: #1250