feat: Add CancellationToken
support for RunBuild.Exec
#10185
Merged
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.
This PR add
CancellationToken
support toRunBuild.Exec
method.It's expected to be used by
docfx watch
command.What's Changed in this PR
Add
CancellationToken
parameter to methods and use token on operations that take times.for
/foreach
operationsParallel.ForEach
operationsAsParallel()
operationsDocumentBuildContext.cs
CancellationToken
property.public
tointernal/private
that used by tests.DocumentExceptionExtensions.cs
AggregateException
on cancellation.Breaking Changes
This PR change some public method signatures.
The user who using
Docfx.Plugins
package need to update versions.Test
Manually run cancellation tests with various delay patterns.
And confirmed operation is canceled with
OperationCanceledException
based exception (includingTaskCanceledException
)