Add IAsyncDisposable support, drop obsolete inheritance-based APIs
#56
Conversation
There was a problem hiding this comment.
Great! Github doesn't allow put comments on unmodified blocks 🤦 .
.ConfigureAwait(false)should be placed now withinOnTickbody
await _batchedLogEventSink.OnEmptyBatchAsync();
await _batchedLogEventSink.EmitBatchAsync(_waitingBatch);since it is called from DisposeAsync.
2. Bump AssemblyVersion to 3.0.0?
| { | ||
| } | ||
| // This is the place where SynchronizationContext.Current is unknown and can be != null | ||
| // so we prevent possible deadlocks here for sync-over-async downstream implementations. |
There was a problem hiding this comment.
comment refers to sync Dispose and can be removed
| // ReSharper disable once MethodHasAsyncOverload | ||
| EmitBatch(events); | ||
| if (_batchedLogEventSink is IAsyncDisposable asyncDisposable) | ||
| await asyncDisposable.DisposeAsync(); |
| </PropertyGroup> | ||
|
|
||
| <ItemGroup> | ||
| <PackageReference Include="Serilog" Version="2.0.0" /> | ||
| <PackageReference Include="Serilog" Version="2.12.0-dev-*" /> |
There was a problem hiding this comment.
Technically this is not needed and can be released independently from the core package. End users would need to update their code anyway by upgrading to the new Serilog version.
But I am ok with this change.
There was a problem hiding this comment.
Thanks for the great review 👍
I rolled this change back; my initial thinking was that downstream sinks relying on async disposal would have more chance of getting support via the app if the version of Serilog itself supported async dispoal - but then realised that most of the time this will need to be via the ASP.NET (and other) hosting APIs, so pulling in an updated Serilog isn't really important here.
|
Think I've got everything; I'll merge this and queue up a release since we'll want it to go out in sync with Serilog 2.12.0. |
Enables asynchronous flushing of queued batches when disposed via
IAsyncDisposable.DisposeAsync(). Batched sinks will now also be disposed viaDisposeAsync()if they support it.See also: serilog/serilog#1750
Dropping subclassing support
The interactions of
Dispose(),Dispose(bool),DisposeAsync(), andDisposeAsyncCore()make retrofitting support in a base class likePeriodicBatchingSinkerror-prone, opening the door to skipped disposal or double-disposal in base classes not explicitly written for async disposal.Since subclassing of
PeriodicBatchingSinkwas already obsoleted, this PR skips the whole unfruitful mess and simply takes the next step by removing subclassing support altogether. Major version bumped to 3.0.0.Migrating existing code to the new API is easy - instead of deriving from
PeriodicBatchingSink, consumers implementIBatchedLogEventSinkinstead, and wrap an instance of the batched sink in anew PeriodicBatchingSink(batchedSink, options).