Skip to content

fix documentation for ExecuteOutcomeAsync (#2680)#2710

Merged
martincostello merged 1 commit intoApp-vNext:mainfrom
carvex21:fix/fix-docs-for-ExecuteOutcomeAsync
Aug 22, 2025
Merged

fix documentation for ExecuteOutcomeAsync (#2680)#2710
martincostello merged 1 commit intoApp-vNext:mainfrom
carvex21:fix/fix-docs-for-ExecuteOutcomeAsync

Conversation

@carvex21
Copy link
Contributor

@carvex21 carvex21 commented Aug 20, 2025

Pull Request

The issue or feature being addressed

Fix the Documentation that has incorrect examples for ExecuteOutcomeAsync #2680

Details on the issue fix or feature implementation

  • Markdown documentation fixes:
  1. Migration Guide (migration-v8.md)
    Replaced example that passed a throwing callback with the safe pattern: wrapping the MethodAsync call in try/catch and returning either Outcome.FromResult(...) or Outcome.FromException(...).

  2. Fallback Strategy (fallback.md)
    Updated the “✅ DO” snippet to wrap user code in try/catch and properly return Outcome, enabling exception remapping logic without throwing from the callback.

  3. Circuit Breaker Strategy (circuit-breaker.md)
    Rewrote the “✅ DO” example to include exception capture via Outcome, and updated post-execution logic to correctly handle both BrokenCircuitException and other errors.

  • XML documentation updates. Strengthened the section on ExecuteOutcomeAsync<TResult, TState> to emphasize that the callback must not throw; users must wrap their code and return an Outcome. This clarifies the contract and prevents accidental misuse that relies on internal implementation details. Files affected:
  1. ResiliencePipeline.AsyncT.cs
  2. ResiliencePipelineT.Async.cs
  • Snippet corrections:
  1. Migration.Execute.cs (snippets used in docs)
    Updated the V8 example (SafeExecute_V8) to use the correct, safe callback pattern: wrapping in try/catch and returning an Outcome. This ensures consistency across sample code and real documentation.

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

@carvex21
Copy link
Contributor Author

@dotnet-policy-service agree

@carvex21 carvex21 marked this pull request as ready for review August 20, 2025 19:35
@carvex21 carvex21 force-pushed the fix/fix-docs-for-ExecuteOutcomeAsync branch 4 times, most recently from 68b2fe0 to 2da95a5 Compare August 22, 2025 14:54
@martincostello
Copy link
Member

The snippets don't compile - please check that they build before committing changes to them.

@carvex21 carvex21 force-pushed the fix/fix-docs-for-ExecuteOutcomeAsync branch from 2da95a5 to 9372c7b Compare August 22, 2025 15:17
@codecov
Copy link

codecov bot commented Aug 22, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 96.12%. Comparing base (651508b) to head (950a4fd).
⚠️ Report is 1 commits behind head on main.
✅ All tests successful. No failed tests found.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2710   +/-   ##
=======================================
  Coverage   96.12%   96.12%           
=======================================
  Files         309      309           
  Lines        7118     7118           
  Branches     1008     1008           
=======================================
  Hits         6842     6842           
  Misses        222      222           
  Partials       54       54           
Flag Coverage Δ
linux 96.12% <ø> (ø)
macos 96.12% <ø> (ø)
windows 96.11% <ø> (ø)

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.

@carvex21 carvex21 force-pushed the fix/fix-docs-for-ExecuteOutcomeAsync branch from 9372c7b to 950a4fd Compare August 22, 2025 15:32
@martincostello martincostello merged commit 708b02b into App-vNext:main Aug 22, 2025
27 checks passed
@martincostello
Copy link
Member

Thanks for the contribution.

PhilipWoulfe pushed a commit to PhilipWoulfe/F1Competition that referenced this pull request Mar 2, 2026
[//]: # (dependabot-start)
⚠️  **Dependabot is rebasing this PR** ⚠️ 

Rebasing might not happen immediately, so don't worry if this takes some
time.

Note: if you make any changes to this PR yourself, they will take
precedence over the rebase.

---

[//]: # (dependabot-end)

Updated [Polly](https://github.com/App-vNext/Polly) from 8.5.2 to 8.6.5.

<details>
<summary>Release notes</summary>

_Sourced from [Polly's
releases](https://github.com/App-vNext/Polly/releases)._

## 8.6.5

## What's Changed

* Extend NuGet package validation by @​martincostello in
App-vNext/Polly#2762
* Suppress S2094 warning by @​martincostello in
App-vNext/Polly#2765
* Refactor cake script by @​martincostello in
App-vNext/Polly#2769
* Pass timeout to `TimeoutRejectedException` by @​martincostello in
App-vNext/Polly#2827

**Full Changelog**:
App-vNext/Polly@8.6.4...8.6.5


## 8.6.4

## What's Changed

* Fix after-release and update CHANGELOG by @​martincostello in
App-vNext/Polly#2714
* Use collection expressions by @​martincostello in
App-vNext/Polly#2715
* Fix flaky mutants by @​martincostello in
App-vNext/Polly#2717
* fix documentation for ExecuteOutcomeAsync by @​carvex21 in
App-vNext/Polly#2710
* Bump MartinCostello.WaitForNuGetPackage by @​martincostello in
App-vNext/Polly#2721
* Bump sign tool by @​martincostello in
App-vNext/Polly#2722
* xunit v3 preparation by @​martincostello in
App-vNext/Polly#2723
* Add summary NuGet badges by @​martincostello in
App-vNext/Polly#2724
* Delete actionlint config by @​martincostello in
App-vNext/Polly#2730
* RateLimiting: add typed builder/guard tests and external limiter
lifetime test by @​mohammed-saalim in
App-vNext/Polly#2711
* Update Dependabot auto-merge conditions by @​martincostello in
App-vNext/Polly#2736
* Bump NuGet packages by @​martincostello in
App-vNext/Polly#2738
* Bump dotnet-stryker to 4.8.1 by @​martincostello in
App-vNext/Polly#2739
* Simplify code by @​martincostello in
App-vNext/Polly#2740
* Update zizmor by @​martincostello in
App-vNext/Polly#2746
* Use NuGet Trusted Publishing by @​martincostello in
App-vNext/Polly#2751
* Respect override for PipelineExecuting and PipelineExecuted by
@​peter-csala in App-vNext/Polly#2752

## New Contributors

* @​carvex21 made their first contribution in
App-vNext/Polly#2710
* @​mohammed-saalim made their first contribution in
App-vNext/Polly#2711

**Full Changelog**:
App-vNext/Polly@8.6.3...8.6.4


## 8.6.3

## What's Changed

* Add release notes configuration by @​martincostello in
App-vNext/Polly#2678
* Simplify release workflow by @​martincostello in
App-vNext/Polly#2679
* Sign-off commits by @​martincostello in
App-vNext/Polly#2694
* Add GitHub sponsorship by @​martincostello in
App-vNext/Polly#2695
* Refactor project dependencies by @​martincostello in
App-vNext/Polly#2696
* Add zizmor by @​martincostello in
App-vNext/Polly#2698
* Update benchmarks by @​martincostello in
App-vNext/Polly#2712
* Reduce async overhead by @​pentp in
App-vNext/Polly#2664
* Update benchmarks by @​martincostello in
App-vNext/Polly#2713

## New Contributors

* @​pentp made their first contribution in
App-vNext/Polly#2664

**Full Changelog**:
App-vNext/Polly@8.6.2...8.6.3


## 8.6.2

## What's Changed

* Performance tweaks by @​martincostello in
App-vNext/Polly#2667
* Update dependencies by @​martincostello in
App-vNext/Polly#2668
* Update benchmark results by @​martincostello in
App-vNext/Polly#2669

## New Contributors

* @​pentp made their first contribution in
App-vNext/Polly#2667

**Full Changelog**:
App-vNext/Polly@8.6.1...8.6.2


## 8.6.1

## What's Changed

* Fix integer overflow in `BulkheadSemaphoreFactory` by @​ahusseini in
App-vNext/Polly#2638
* Generate SBOM by @​martincostello in
App-vNext/Polly#2640
* Attest artifacts by @​martincostello in
App-vNext/Polly#2647

## New Contributors

* @​ahusseini made their first contribution in
App-vNext/Polly#2638

**Full Changelog**:
App-vNext/Polly@8.6.0...8.6.1

## 8.6.0

## What's Changed

* Bump Stryker by @​martincostello in
App-vNext/Polly#2476
* Fix chaos example issue and enrich notes & diagram by @​caigen in
App-vNext/Polly#2482
* Add diagram for the main chaos page sample by @​peter-csala in
App-vNext/Polly#2484
* Fix broken CI by @​martincostello in
App-vNext/Polly#2497
* Remove .NET 6 SDK by @​martincostello in
App-vNext/Polly#2501
* Use Stryker Mutator Dashboard by @​martincostello in
App-vNext/Polly#2500
* Fix Polly.Testing mutations by @​martincostello in
App-vNext/Polly#2503
* Lint PowerShell scripts by @​martincostello in
App-vNext/Polly#2504
* Improve Polly coverage by @​martincostello in
App-vNext/Polly#2505
* Improve mutation score by @​martincostello in
App-vNext/Polly#2506
* Run CodeQL for GitHub Actions by @​martincostello in
App-vNext/Polly#2498
* Add missing mutations by @​martincostello in
App-vNext/Polly#2508
* Remove dotnet tool restore by @​martincostello in
App-vNext/Polly#2513
* Add missing coverage by @​martincostello in
App-vNext/Polly#2514
* Improve mutation test perf by @​slang25 in
App-vNext/Polly#2520
* Improve coverage by @​martincostello in
App-vNext/Polly#2526
* Remove System.Text.Json reference by @​martincostello in
App-vNext/Polly#2532
* Fix test summary reliability by @​martincostello in
App-vNext/Polly#2543
* Use AuthenticodeLint by @​martincostello in
App-vNext/Polly#2553
* Use actions/create-github-app-token by @​martincostello in
App-vNext/Polly#2572
* Fix Retry strategy ShouldHandle in example code by @​marcrocny in
App-vNext/Polly#2527
* Tweak docs formatting by @​martincostello in
App-vNext/Polly#2575
* Dispose registry which contains rate limiters by @​peter-csala in
App-vNext/Polly#2578
* Improve mutation tests performance by ensuring solution file isn't
discovered by @​slang25 in App-vNext/Polly#2589
* Update LICENSE metadata by @​martincostello in
App-vNext/Polly#2590
* Add HTTP client integration samples by @​peter-csala in
App-vNext/Polly#2587
* Dedupe links by @​martincostello in
App-vNext/Polly#2592
* Add test analytics by @​martincostello in
App-vNext/Polly#2593
* Add note about context/state mix-ups by @​martincostello in
App-vNext/Polly#2598
* Emit annotation for packages by @​martincostello in
App-vNext/Polly#2601
* Add `AttemptNumber` to `HedgingPredicateArguments` by @​peter-csala in
App-vNext/Polly#2603
* .NET 10 preparation by @​martincostello in
App-vNext/Polly#2620
* Migrate to slnx by @​martincostello in
App-vNext/Polly#2623
* Fix `OnRetryArguments` comments by @​lchaoer in
App-vNext/Polly#2627
* Fix package signing by @​martincostello in
App-vNext/Polly#2631

## New Contributors

* @​caigen made their first contribution in
App-vNext/Polly#2482
* @​slang25 made their first contribution in
App-vNext/Polly#2520
* @​marcrocny made their first contribution in
App-vNext/Polly#2527
* @​lchaoer made their first contribution in
App-vNext/Polly#2627

**Full Changelog**:
App-vNext/Polly@8.5.2...8.6.0

Commits viewable in [compare
view](App-vNext/Polly@8.5.2...8.6.5).
</details>

[![Dependabot compatibility
score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=Polly&package-manager=nuget&previous-version=8.5.2&new-version=8.6.5)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)

Dependabot will resolve any conflicts with this PR as long as you don't
alter it yourself. You can also trigger a rebase manually by commenting
`@dependabot rebase`.

[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)

---

<details>
<summary>Dependabot commands and options</summary>
<br />

You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits
that have been made to it
- `@dependabot show <dependency name> ignore conditions` will show all
of the ignore conditions of the specified dependency
- `@dependabot ignore this major version` will close this PR and stop
Dependabot creating any more for this major version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop
Dependabot creating any more for this minor version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop
Dependabot creating any more for this dependency (unless you reopen the
PR or upgrade to it yourself)


</details>

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
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.

2 participants