Skip to content

Latest commit

 

History

History
762 lines (636 loc) · 67.7 KB

CHANGELOG.md

File metadata and controls

762 lines (636 loc) · 67.7 KB
Raw

CHANGELOG

8.4.0

8.3.1

8.3.0

8.2.1

8.2.0

8.1.0

8.0.0

8.0.0-beta.2

8.0.0-beta.1

8.0.0-alpha.9

8.0.0-alpha.8

8.0.0-alpha.7

8.0.0-alpha.6

8.0.0-alpha.5

8.0.0-alpha.4

8.0.0-alpha.3

8.0.0-alpha.2

8.0.0-alpha.1

Thanks to:

7.2.4

  • Fixed an incorrect exception argument - Thanks to @FoxTes
  • Upgrade FluentAssertions - Thanks to @dotnetspark
  • Upgrade Cake - Thanks to @eugeneogongo
  • Fixed possible NullReferenceException - Thanks to @FoxTes
  • Migrate build to GitHub Actions - Thanks to @martincostello
  • Authenticode sign the assembly and NuGet package - Thanks to @martincostello and the .NET Foundation

7.2.3

7.2.2

  • Recursively search all AggregateException inner exceptions for predicate matches when using HandleInner() (#818) - Thanks to @sideproject
  • Polly now builds deterministically - Thanks to @304NotModified
  • Bug fix: the timeoutStrategy parameter was not being used by the TimeoutAsync(Func<TimeSpan>, TimeoutStrategy, Func<Context, TimeSpan, Task, Task>) method - Thanks to @martincostello
  • Bug fix: the solution can now be built with the .NET 5.0 SDK - Thanks to @martincostello

7.2.1

  • Upgrade SourceLink to RTM v1 (fixes building from source for latest .NET Core 3.1.x)
  • Bug fix: rare circuit-breaker race condition causing NullReferenceException when circuit throws BrokenCircuitException.

7.2.0

  • Add test target for netcoreapp3.0.
  • Extend PolicyRegistry with concurrent method support, TryAdd, TryRemove, TryUpdate, GetOrAdd, AddOrUpdate; new interface IConcurrentPolicyRegistry
  • Improve .NET Framework support: Add explicit targets for .NET Framework 4.6.1 and 4.7.2.
  • TimeoutPolicy: if timeout occurs while a user exception is being marshalled (edge case race condition), do not mask user exception (fix issue 620)
  • Enhance debugging/stacktrace experience for some contexts: Include pdb symbols in package again.

7.1.1

  • Bug fix: ensure async retry policies honor continueOnCapturedContext setting (affected v7.1.0 only).
  • Remove deprecated cake add-in from build

7.1.0

  • Add SourceLink debugger support.
  • Bug fix: PolicyRegistry with .NET Core services.AddPolicyRegistry() overload (affected Polly v7.0.1-3 only)
  • Rationalise solution layout
  • Add explicit .NET framework 4.6.2 and 4.7.2 test runs

7.0.3

  • Bug fix for AdvancedCircuitBreakerAsync<TResult> (issue affecting v7.0.1-2 only)

7.0.2

  • Bug fix for PolicyRegistry (issue affecting v7.0.1 only)

7.0.1

  • Clarify separation of sync and async policies (breaking change)
  • Enable extensibility by custom policies hosted external to Polly
  • Enable collection initialization syntax for PolicyRegistry
  • Enable cache policies to cache default(TResult) (breaking change)
  • Restore Exception binary serialization for .Net Standard 2.0

6.1.2

  • Bug Fix: Async continuation control for async executions (issue 540, affected only v6.1.1)

6.1.1

  • Bug Fix: Context.PolicyKey behaviour in PolicyWrap (issue 510)

6.1.0

  • Bug Fix: Context.PolicyKey behaviour in PolicyWrap (issue 463)
  • Bug Fix: CachePolicy behaviour with non-nullable types (issues 472, 475)
  • Enhancement: WaitAnd/RetryForever overloads where onRetry takes the retry number as a parameter (issue 451)
  • Enhancement: Overloads where onTimeout takes thrown exception as a parameter (issue 338)
  • Enhancement: Improved cache error message (issue 455)

6.0.1

  • Version 6 RTM, for integration to ASP.NET Core 2.1 IHttpClientFactory

6.0.0-v6alpha

  • Publish as strong-named package only (discontinue non-strong-named versions)
  • Add .NetStandard 2.0 tfm
  • Provide .NET4.5 support via .NetStandard 1.1 tfm
  • Discontinue .NET4.0 support
  • Remove methods marked as deprecated in v5.9.0

5.9.0

  • Allow Timeout.InfiniteTimeSpan (no timeout) for TimeoutPolicy.
  • Add .AsPolicy<TResult> and .AsAsyncPolicy<TResult> methods for converting non-generic policies to generic policies.
  • Per Semver, indicates deprecation of overloads and properties intended to be removed or renamed in Polly v6.

5.8.0

  • Add a new onBreak overload that provides the prior state on a transition to an open state
  • Bug fix: RelativeTtl in CachePolicy now always returns a ttl relative to time item is cached

5.7.0

  • Minor cache fixes
  • Add ability to calculate cache Ttl based on item to cache
  • Allow user-created custom policies

5.6.1

  • Extend PolicyWrap syntax with interfaces

5.6.0

  • Add ability to handle inner exceptions natively: .HandleInner<TEx>()
  • Allow WaitAndRetry policies to calculate wait based on the handled fault
  • Add the ability to access the policies within an IPolicyWrap
  • Allow PolicyWrap to configure policies expressed as interfaces
  • Bug fix: set context keys for generic execute methods with PolicyWrap
  • Bug fix: generic TResult method with non-generic fallback policy
  • Performance improvements
  • Multiple build speed improvements

5.5.0

  • Bug fix: non-generic CachePolicy with PolicyWrap
  • Add Cache interfaces

5.4.0

  • Add CachePolicy: cache-aside pattern, with interfaces for pluggable cache providers and serializers.
  • Bug fix: Sync TimeoutPolicy in pessimistic mode no longer interposes AggregateException.
  • Provide public factory methods for PolicyResult, to support testing.
  • Fallback delegates can now take handled fault as input parameter.

5.3.1

  • Make ISyncPolicy<TResult> public
  • (Upgrade solution to msbuild15)

5.3.0

  • Fix ExecuteAndCapture() usage with PolicyWrap
  • Allow Fallback delegates to take execution Context
  • Provide IReadOnlyPolicyRegistry interface

5.2.0

  • Add PolicyRegistry for storing and retrieving policies.
  • Add interfaces by policy type and execution type.
  • Change .NetStandard minimum support to NetStandard1.1.

5.1.0

  • Allow different parts of a policy execution to exchange data via a mutable Context travelling with each execution.

5.0.6

  • Update NETStandard.Library dependency to latest 1.6.1 for .NetStandard1.0 target. Resolves compatibility for some Xamarin targets.

5.0.5

  • Bug fix: Prevent request stampede during half-open state of CircuitBreaker and AdvancedCircuitBreaker. Enforce only one new trial call per break duration, during half-open state.
  • Bug fix: Prevent duplicate raising of the onBreak delegate, if executions started when a circuit was closed, return faults when a circuit has already opened.
  • Optimisation: Optimise hotpaths for Circuit-Breaker, Retry and Fallback policies.
  • Minor behavioural change: For a circuit which has not handled any faults since initialisation or last reset, make LastException property return null rather than a fake exception.
  • Add NoOpPolicy: NoOpPolicy executes delegates without intervention; for eg stubbing out Polly in unit testing.

5.0.4 pre

  • Fix Microsoft.Bcl and Nito.AsyncEx dependencies for Polly.Net40Async.

5.0.3 RTM

  • Refine implementation of cancellable synchronous WaitAndRetry
  • Minor breaking change: Where a user delegate does not observe cancellation, Polly will now honour the delegate's outcome rather than throw for the unobserved cancellation (issue 188).

5.0.2 alpha

  • .NETStandard1.0 target: Correctly state dependencies.
  • .NETStandard1.0 target: Fix SemVer stamping of Polly.dll.
  • PCL259 project and target: Remove, in favour of .NETStandard1.0 target. PCL259 is supported via .NETStandard1.0 target, going forward.
  • Mark Polly.dll as CLSCompliant.
  • Tidy build around GitVersionTask and ReferenceGenerator.
  • Update FluentAssertions dependency.
  • Added Polly.Net40Async specs project.
  • Fix issue 179: Make Net4.0 async implementation for Bulkhead truly async.

5.0.1 alpha

  • Add .NET Standard 1.0 project and target.

5.0.0 alpha

A major release, adding significant new resilience policies:

  • Timeout policy: allows timing out any execution. Thanks to @reisenberger.
  • Bulkhead isolation policy: limits the resources consumable by governed actions, such that a faulting channel cannot cause cascading failures. Thanks to @reisenberger and contributions from @brunolauze.
  • Fallback policy: provides for a fallback execution or value, in case of overall failure. Thanks to @reisenberger
  • PolicyWrap: allows flexibly combining Policy instances of any type, to form an overall resilience strategy. Thanks to @reisenberger

Other changes include:

  • Add PolicyKeys and context to all policy executions, for logging and to support later introduction of policy events and metrics. Thanks to @reisenberger
  • Add CancellationToken support to synchronous executions. Thanks to @brunolauze and @reisenberger
  • Add some missing ExecuteAndCapture/Async overloads. Thanks to @reisenberger
  • Remove invalid ExecuteAsync overloads taking (but not making use of) a CancellationToken
  • Provide .NET4.0 support uniquely through Polly.NET40Async package
  • Retire ContextualPolicy (not part of documented API; support now in Policy base class)
  • Discontinue .NET3.5 support

4.3.0

  • Added ability for policies to handle returned results. Optimised circuit-breaker hot path. Fixed circuit-breaker threshold bug. Thanks to @reisenberger, @christopherbahr and @Finity respectively.

4.2.4

  • Added overloads to WaitAndRetry and WaitAndRetryAsync methods that accept an onRetry delegate which includes the attempt count. Thanks to @SteveCote

4.2.3

  • Updated the Polly.Net40Async NuGet package to enable async via the SUPPORTSASYNC constant. Cleaned up the build scripts in order to ensure unnecessary DLL references are not included within each of the framework targets. Thanks to @reisenberger and @joelhulen

4.2.2

  • Add new Polly.Net40Async project/package supporting async for .NET40 via Microsoft.Bcl.Async. Thanks to @Lumirris

4.2.1

  • Allowed async onRetry delegates to async retry policies. Thanks to @reisenberger

4.2.0

4.1.2

  • Fixed an issue with the onReset delegate of the CircuitBreaker.

4.1.1

  • Add ExecuteAndCapture support with arbitrary context data - Thanks to @reisenberger

4.1.0

  • Add Wait and retry forever policy - Thanks to @nedstoyanov
  • Remove time-limit on CircuitBreaker state-change delegates - Thanks to @reisenberger

4.0.0

  • Add async support and circuit-breaker support for ContextualPolicy
  • Add manual control of circuit-breaker (reset and manual circuit isolation)
  • Add public reporting of circuit-breaker state, for health/performance monitoring
  • Add delegates on changes of circuit state
  • Thanks to @reisenberger

3.0.0

  • Add cancellation support for all async Policy execution - Thanks to @reisenberger

2.2.7

  • Fixes an issue where continueOnCapturedContext needed to be specified in two places (on action execution and Policy configuration), when wanting to flow async action execution on the captured context - Thanks to @reisenberger
  • Fixes excess line ending issues

2.2.6

  • Async sleep fix, plus added continueOnCapturedContext parameter on async methods to control whether continuation and retry will run on captured synchronization context - Thanks to @yevhen

2.2.5

  • Policies with a retry count of zero are now allowed - Thanks to @nelsonghezzi

2.2.4

  • Add .NET Core support

2.2.3

  • Fix PCL implementation of SystemClock.Reset
  • Added ability to capture the results of executing a policy via ExecuteAndCapture - Thanks to @ThomasMentzel

2.2.2

  • Added extra NotOnCapturedContext call to prevent potential deadlocks when blocking on asynchronous calls - Thanks to Hacko

2.2.1

  • Replaced non-blocking sleep implementation with a blocking one for PCL

2.2.0

  • Added Async Support (PCL)
  • PCL Profile updated from Profile78 -> Profile 259
  • Added missing WaitAndRetryAsync overload

2.1.0

  • Added Async Support (.NET Framework 4.5 Only) - Massive thanks to @mauricedb for the implementation

2.0.0

  • Added Portable Class Library (Issue #4) - Thanks to @ghuntley for the implementation
  • The Polly NuGet package is now no longer strongly named. The strongly named NuGet package is now Polly-Signed (Issue #5)

1.1.0

  • Added additional overloads to Retry
  • Allow arbitrary data to be passed to policy execution (Issue #1)