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

API Review Feedback #1506

Merged
merged 3 commits into from
Aug 22, 2023
Merged

API Review Feedback #1506

merged 3 commits into from
Aug 22, 2023

Conversation

martintmk
Copy link
Contributor

@martintmk martintmk commented Aug 22, 2023

Details on the issue fix or feature implementation

  • Drop ResilienceContext.ResilienceEvents
  • Rename ResiliencePipeline.Null to ResiliencePipeline.Empty
  • Hide some Outcome<> properties
  • Drop RateLimiterRejected.RetryAfter

Contributes to #1233

Confirm the following

  • I started this PR by branching from the head of the default branch
  • I have targeted the PR to merge into the default branch
  • I have included unit tests for the issue/feature
  • I have successfully run a local build

@martintmk martintmk added the v8 Issues related to the new version 8 of the Polly library. label Aug 22, 2023
@martintmk martintmk added this to the v8.0.0 milestone Aug 22, 2023
@martintmk martintmk self-assigned this Aug 22, 2023
@martincostello
Copy link
Member

At this point I'm finding #1233 too unwieldly to follow so I've stopped keeping up to date with it.

How many more changes are we expecting before we actually freeze the public API unless there's specific user feedback in an issue?

@codecov
Copy link

codecov bot commented Aug 22, 2023

Codecov Report

Merging #1506 (e82c984) into main (69e5f16) will decrease coverage by 0.06%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##             main    #1506      +/-   ##
==========================================
- Coverage   83.91%   83.86%   -0.06%     
==========================================
  Files         273      272       -1     
  Lines        6503     6481      -22     
  Branches     1026     1020       -6     
==========================================
- Hits         5457     5435      -22     
  Misses        837      837              
  Partials      209      209              
Flag Coverage Δ
linux ?
macos 83.86% <100.00%> (?)
windows 83.86% <100.00%> (-0.06%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files Changed Coverage Δ
...Core/Hedging/Controller/HedgingExecutionContext.cs 100.00% <ø> (ø)
src/Polly.Core/ResilienceContext.cs 100.00% <ø> (ø)
...olly.Core/Telemetry/ResilienceStrategyTelemetry.cs 100.00% <ø> (ø)
...lly.RateLimiting/OnRateLimiterRejectedArguments.cs 100.00% <ø> (ø)
src/Polly.Core/Outcome.TResult.cs 100.00% <100.00%> (ø)
src/Polly.Core/ResiliencePipeline.cs 100.00% <100.00%> (ø)
src/Polly.Core/ResiliencePipelineBuilderBase.cs 100.00% <100.00%> (ø)
src/Polly.Core/ResiliencePipelineT.cs 100.00% <100.00%> (ø)
src/Polly.Core/Utils/Pipeline/PipelineComponent.cs 100.00% <100.00%> (ø)
...olly.Extensions/Telemetry/TelemetryListenerImpl.cs 100.00% <100.00%> (ø)
... and 1 more

@martintmk
Copy link
Contributor Author

At this point I'm finding #1233 too unwieldly to follow so I've stopped keeping up to date with it.

How many more changes are we expecting before we actually freeze the public API unless there's specific user feedback in an issue?

Hopefully not too many. We are trying to wrap the API by the end of the month. It's mostly about hiding/dropping some stuff and polishing the surface.

Just thinking, would opening a new PR with something like Polly V8: Public API Review (final polish) actually help?

@martincostello
Copy link
Member

Just thinking, would opening a new PR with something like Polly V8: Public API Review (final polish) actually help?

Possibly.

The main problem I have is that the diff is massive so looking for inline comments when I've marked a file as reviewed is difficult, and there's so many comments on the PR that most of them are hidden if they're old:

image

@martintmk martintmk enabled auto-merge (squash) August 22, 2023 15:37
@martintmk
Copy link
Contributor Author

Just thinking, would opening a new PR with something like Polly V8: Public API Review (final polish) actually help?

Possibly.

The main problem I have is that the diff is massive so looking for inline comments when I've marked a file as reviewed is difficult, and there's so many comments on the PR that most of them are hidden if they're old:

image

Let me give a shot at this tomorrow. There are maybe 10 comments left to address. Some of these came just recently, however it might be good to have something where one is not immediately lost :)

@martintmk martintmk merged commit a61b343 into main Aug 22, 2023
@martintmk martintmk deleted the mtomka/api-cleanup branch August 22, 2023 15:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
v8 Issues related to the new version 8 of the Polly library.
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants