Clean up exposure and handling of CancellationToken #612
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
- In public API, they should always be the last parameter (unless they can't be, e.g. due to a params array), named "cancellationToken", and be non-nullable. - Ensure they're forwarded appropriately from one API to the next. There may be some more missing cases, but I fixed all the ones I found. - Make the XML docs consistent. - Remove unnecessary cancellation-related analyzer suppressions One issue I noticed I haven't addressed here: - Some APIs take both an SKContext and a CancellationToken separately. If both are supplied, one of the tokens (either the explicitly passed one or the one from the SKContext) might be ignored. If they're not the same token and they're both cancelable, a combined token should really be passed on to the target so that the target ends up monitoring both.
github-actions
bot
added
.NET
lemillermicrosoft
previously approved these changes
Apr 24, 2023
lemillermicrosoft
added
the
PR: ready to merge
|
Todo: for ISKFunction and Plan it would be nice having the cancellation token as an optional parameter, without ever forcing the user to pass one. There are a lot of changes so I'll have to check the code locally. As a guideline, if the context is available, I would assume it has a valid cancellation token. If the context is created locally though, that's false so we need to check for that scenario. If the context is null and the user didn't pass a cancellation token I think we should log a warning (or an error). |
lemillermicrosoft
added
the
PR: ready for review
shawncal
reviewed
Apr 27, 2023
dluc
reviewed
Apr 28, 2023
dluc
added
PR: feedback to address
github-actions
bot
added
the
kernel
shawncal
approved these changes
May 1, 2023
codebrain
pushed a commit
to searchpioneer/semantic-kernel
that referenced
this pull request
May 16, 2023
### Motivation and Context Clean up exposure and handling of CancellationToken in public APIs. ### Description - In public API, they should always be the last parameter (unless they can't be, e.g. due to a params array), named "cancellationToken", and be non-nullable. - Ensure they're forwarded appropriately from one API to the next. There may be some more missing cases, but I fixed all the ones I found. - Make the XML docs consistent. - Remove unnecessary cancellation-related analyzer suppressions
dehoward
pushed a commit
to lemillermicrosoft/semantic-kernel
that referenced
this pull request
Jun 1, 2023
### Motivation and Context Clean up exposure and handling of CancellationToken in public APIs. ### Description - In public API, they should always be the last parameter (unless they can't be, e.g. due to a params array), named "cancellationToken", and be non-nullable. - Ensure they're forwarded appropriately from one API to the next. There may be some more missing cases, but I fixed all the ones I found. - Make the XML docs consistent. - Remove unnecessary cancellation-related analyzer suppressions
golden-aries
pushed a commit
to golden-aries/semantic-kernel
that referenced
this pull request
Oct 10, 2023
### Motivation and Context Clean up exposure and handling of CancellationToken in public APIs. ### Description - In public API, they should always be the last parameter (unless they can't be, e.g. due to a params array), named "cancellationToken", and be non-nullable. - Ensure they're forwarded appropriately from one API to the next. There may be some more missing cases, but I fixed all the ones I found. - Make the XML docs consistent. - Remove unnecessary cancellation-related analyzer suppressions
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.
Motivation and Context
Clean up exposure and handling of CancellationToken in public APIs.
Description
One issue I noticed I haven't addressed here:
Contribution Checklist
dotnet format