Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[release/7.0] Rename request count to permit count on System.Threading.RateLimiting #76623

Merged
merged 1 commit into from
Oct 5, 2022

Conversation

github-actions[bot]
Copy link
Contributor

@github-actions github-actions bot commented Oct 4, 2022

Backport of #76558 to release/7.0

/cc @BrennanConroy @AliKhalili

Customer Impact

API is inconsistent with other rate limiters (ConcurrencyLimiter) and other APIs (the options refer to permits not requests), and not what was approved during API review. This can cause confusion. And we can't change this later as it is a source breaking change.

Testing

N/A

Risk

Code using System.Threading.RateLimiting in previews, RC1, or RC2 may fail to compile after this change if using parameter names. e.g. limiter.AttemptAcquireCore(requestCount: 3);
Fortunately, it'll be very easy to fix broken code, change requestCount to permitCount.

@dotnet-issue-labeler
Copy link

Note regarding the new-api-needs-documentation label:

This serves as a reminder for when your PR is modifying a ref *.cs file and adding/modifying public APIs, to please make sure the API implementation in the src *.cs file is documented with triple slash comments, so the PR reviewers can sign off that change.

@ghost
Copy link

ghost commented Oct 4, 2022

Tagging subscribers to this area: @mangod9
See info in area-owners.md if you want to be subscribed.

Issue Details

Backport of #76558 to release/7.0

/cc @BrennanConroy @AliKhalili

Customer Impact

Testing

Risk

IMPORTANT: Is this backport for a servicing release? If so and this change touches code that ships in a NuGet package, please make certain that you have added any necessary package authoring and gotten it explicitly reviewed.

Author: github-actions[bot]
Assignees: -
Labels:

area-System.Threading, new-api-needs-documentation

Milestone: -

@BrennanConroy BrennanConroy added the Servicing-consider Issue for next servicing release review label Oct 4, 2022
@rbhanda rbhanda added Servicing-approved Approved for servicing release and removed Servicing-consider Issue for next servicing release review labels Oct 4, 2022
@rbhanda rbhanda added this to the 7.0.0 milestone Oct 4, 2022
@carlossanlop
Copy link
Member

@BrennanConroy can you please provide a code review sign-off?

@BrennanConroy
Copy link
Member

@carlossanlop good to merge?

@carlossanlop carlossanlop merged commit d8b3db4 into release/7.0 Oct 5, 2022
@carlossanlop carlossanlop deleted the backport/pr-76558-to-release/7.0 branch October 5, 2022 18:00
@ghost ghost locked as resolved and limited conversation to collaborators Nov 4, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants