Start adopting Swift Concurrency #1349
Open
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.
Bug/issue #, if applicable:
Summary
This starts adopting Swift Concurrency in two places of SwiftDocC.
Using
async letbindings during context initialization simplifies this patternto something like
Using a throwing task group for rendering (turning documentation nodes into render nodes) allows that code to
throwerrors instead of turning them into fakeDiagnosticvalues. This simplifies the calling code by not having it mix user-facing issues and unexpected errors (like failing to write a file to disk).Additionally, with the task groups code extracting it's easier to check for cancellations which enables
docc previewto refresh faster when making edits in quick succession on larger projects.As a future direction we can build on the extracted task group code to update our
concurrentMapandconcurrentPerformhelpers. However, their callers are somewhat deep and would need to be markedasyncwhich would need to propane up through their callers and their callers until reaching an alreadyasyncmethod. For this reason, it might be better to work top-down instead until we reach these callers.Dependencies
None
Testing
Nothing in particular. This isn't a user-facing change.
Checklist
Make sure you check off the following items. If they cannot be completed, provide a reason.
./bin/testscript and it succeeded