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

Preliminary API Review (2) #1186

Merged
merged 3 commits into from
May 16, 2023
Merged

Preliminary API Review (2) #1186

merged 3 commits into from
May 16, 2023

Conversation

martintmk
Copy link
Contributor

@martintmk martintmk commented May 16, 2023

Details on the issue fix or feature implementation

Just addressing some of the issues found when doing internal API review. We want to do some initial pass before we engage with broader audience.

  • Fixed some docs.
  • Dropping custom delegates and using Func<> instead.
  • Dropping some APIs from Outcome.
  • Embracing System.Threading.Timeout.InfiniteTimeSpan instead of custom API.

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 May 16, 2023
@martintmk martintmk added this to the v8.0.0 milestone May 16, 2023
Comment on lines 26 to 28
/// Make sure that the action returned by the generator represents a real asynchronous work, otherwise the hedging
/// engine will be blocked and parallel hedged actions won't ever be executed. The generator can return a <see langword="null"/> function.
/// In such case the hedging is not executed for that attempt.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
/// Make sure that the action returned by the generator represents a real asynchronous work, otherwise the hedging
/// engine will be blocked and parallel hedged actions won't ever be executed. The generator can return a <see langword="null"/> function.
/// In such case the hedging is not executed for that attempt.
/// Make sure that the action returned by the generator represents real asynchronous work, otherwise the hedging
/// engine will be blocked and parallel hedged actions won't ever be executed. The generator can return a <see langword="null"/> function.
/// In such a case the hedging is not executed for that attempt.

Comment on lines 25 to 27
/// Make sure that the action returned by the generator represents a real asynchronous work, otherwise the hedging
/// engine will be blocked and parallel hedged actions won't ever be executed. The generator can return a <see langword="null"/> function.
/// In such case the hedging is not executed for that attempt.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
/// Make sure that the action returned by the generator represents a real asynchronous work, otherwise the hedging
/// engine will be blocked and parallel hedged actions won't ever be executed. The generator can return a <see langword="null"/> function.
/// In such case the hedging is not executed for that attempt.
/// Make sure that the action returned by the generator represents real asynchronous work, otherwise the hedging
/// engine will be blocked and parallel hedged actions won't ever be executed. The generator can return a <see langword="null"/> function.
/// In such a case the hedging is not executed for that attempt.

@martintmk martintmk enabled auto-merge (squash) May 16, 2023 06:30
@codecov-commenter
Copy link

codecov-commenter commented May 16, 2023

Codecov Report

Merging #1186 (380244e) into main (e6b3e00) will decrease coverage by 0.03%.
The diff coverage is 100.00%.

❗ Your organization is not using the GitHub App Integration. As a result you may experience degraded service beginning May 15th. Please install the Github App Integration for your organization. Read more.

@@            Coverage Diff             @@
##             main    #1186      +/-   ##
==========================================
- Coverage   83.42%   83.40%   -0.03%     
==========================================
  Files         273      273              
  Lines        6329     6321       -8     
  Branches     1028     1028              
==========================================
- Hits         5280     5272       -8     
  Misses        844      844              
  Partials      205      205              
Flag Coverage Δ
linux ?
macos 83.40% <100.00%> (-0.03%) ⬇️
windows 83.40% <100.00%> (?)

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

Impacted Files Coverage Δ
...Core/CircuitBreaker/CircuitBreakerManualControl.cs 100.00% <ø> (ø)
...CircuitBreaker/CircuitBreakerPredicateArguments.cs 100.00% <ø> (ø)
...ly.Core/CircuitBreaker/OnCircuitClosedArguments.cs 100.00% <ø> (ø)
...ore/CircuitBreaker/OnCircuitHalfOpenedArguments.cs 100.00% <ø> (ø)
...ly.Core/CircuitBreaker/OnCircuitOpenedArguments.cs 100.00% <ø> (ø)
src/Polly.Core/Fallback/FallbackHandler.cs 100.00% <ø> (ø)
.../Polly.Core/Fallback/FallbackResilienceStrategy.cs 100.00% <ø> (ø)
...ack/FallbackResilienceStrategyBuilderExtensions.cs 100.00% <ø> (ø)
src/Polly.Core/Fallback/HandleFallbackArguments.cs 100.00% <ø> (ø)
src/Polly.Core/Fallback/OnFallbackArguments.cs 100.00% <ø> (ø)
... and 32 more

@martintmk martintmk merged commit bda07eb into main May 16, 2023
@martintmk martintmk deleted the mtomka/api-review-1 branch May 16, 2023 07:41
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.

3 participants