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

[Docs] Fix hedging documentation about unhappy paths #1730

Conversation

peter-csala
Copy link
Contributor

Pull Request

The issue or feature being addressed

  • In all concurrency modes the hedging strategy returns the primary execution's failure if all attempts fail
  • The documentation used the the following wording: first failure encountered
    • This is misleading since it can be interpreted as fastest execution's failure

Details on the issue fix or feature implementation

  • Rephrased the documentation to clarify which result would be the final result
  • Updated parallel mode's unhappy path's sequence diagram
  • Added a parameterized unit test to the HedgingResilienceStrategyTests

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

@peter-csala
Copy link
Contributor Author

@martincostello Do you have any idea why the publish-docs step failed? I don't see anything which is related to this PR's code change.

@codecov
Copy link

codecov bot commented Oct 26, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (9e036de) 84.56% compared to head (0de87d8) 84.56%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1730   +/-   ##
=======================================
  Coverage   84.56%   84.56%           
=======================================
  Files         307      307           
  Lines        6790     6790           
  Branches     1043     1043           
=======================================
  Hits         5742     5742           
  Misses        839      839           
  Partials      209      209           
Flag Coverage Δ
linux 84.56% <ø> (?)
macos 84.56% <ø> (ø)
windows 84.56% <ø> (ø)

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

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@martincostello
Copy link
Member

@martincostello Do you have any idea why the publish-docs step failed? I don't see anything which is related to this PR's code change.

Nope - it randomly failed yesterday too. I just restarted it.

@martincostello
Copy link
Member

Do you want to try adding dotnet build --configuration Release to the command in your PR like here?

It's worked twice in a row, although it does have a single warning.

https://github.com/App-vNext/Polly/pull/1731/files#diff-c04119feaeffc2c216f069aec66797f2f839a2074287060698e3a2440dec8d45R46

@martincostello martincostello merged commit 9b2b170 into App-vNext:main Oct 26, 2023
18 checks passed
@peter-csala peter-csala deleted the fix-hedging-documentation-about-unhappy-path branch October 31, 2023 16:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants