Add support for CancellationTokens within client and services methods.

[AhmedZaki99]

This one is a little bigger than usual.

Since HttpClient supports optional CancellationToken in its methods, TodoistRestClient can be changed to accept cancellation tokens and pass them to HttpClient method calls.

First, important things to consider:

1. Changes to TodoistRestClient should not affect consumers of that class, so the CancellationToken must be optional.
2. Any changes to the ITodoistRestClient interface would break classes that implement it, so the interface should remain unchanged.

Based on those constraints, to accept the optional CancellationToken, an ICancellableTodoistRestClient interface is added that inherits from ITodoistRestClient and extends it with method overloads that accept the CancellationToken parameter.
TodoistRestClient is then changed to implement ICancellableTodoistRestClient and support cancellation.

Second, cancellation tokens are like async methods; they are “contagious” all the way down the method call chain. This means in order to utilize the usage of cancellation tokens added to TodoistRestClient, then TodoistClient, TodoistTokenlessClient, and all services that depend on them need to have optional CancellationToken parameter in their methods as well.

Changes then were too many so they were split into four commits to become easy to review:

1. Duplicate documentation comments were replaced by <inheritdoc> tag so they change dynamically when CancellationToken parameters are added to interfaces.
2. The ICancellableTodoistRestClient is added along with the TodoistRestClient implementation for it.
3. TodoistClient is updated to support cancellation by checking if the _restClient field implements ICancellableTodoistRestClient and then passes the CancellationToken to it.
4. All other services that depend on the TodoistClient are updated to accept cancellation tokens and pass them to TodoistClient methods.

I hope you find this contribution useful and not too hard to review.

[AhmedZaki99]

One extra change has been committed:
A constructor overload for TodoistClient has been added that accepts an ICancellableTodoistRestClient argument, to explicitly state that the TodoistClient can be instantiated using a cancellable client implementation.

This change is not necessarily part of the proposed contribution, it's just a design change. It's up to you to include it in the merge if you accept the pull request.

[olsh]

Thank you for the contibution 👍🏻
I'll take a look a bit later.

[olsh]

Any changes to the ITodoistRestClient interface would break classes that implement it, so the interface should remain unchanged.

I'd choose breaking changes over introducing a new interface in this case.
I suggest that we increase the library major version and add a cancellation token parameter to ITodoistRestClient and delete ICancellableTodoistRestClient.

[AhmedZaki99]

Ok, I will add a commit with these changes.

[AhmedZaki99]

ITodoistRestClient now supports cancellation tokens directly, and implementing classes like Todoist.Net.TodoistRestClient and Todoist.Net.Tests.RateLimitAwareRestClient has been changed accordingly.

[sonarqubecloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
0.0% Duplication