Fix infinite hang #51
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
This PR introduces timeouts during disposal and write operations to prevent infinite hangs, while also refactoring cancellation token usage and test setups.
- Introduces new CancellationTokenSources (_disposingCts and _forceQuitCts) with configurable write and disposal timeouts.
- Overloads TCPSink and related configuration extensions to support timeout parameters.
- Refactors tests to use freely bound ports and removes duplicate test implementations.
Reviewed Changes
Copilot reviewed 12 out of 13 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| Serilog.Sinks.Network/Sinks/UDP/UDPSink.cs | Removed redundant _socket = null assignment in Dispose. |
| Serilog.Sinks.Network/Sinks/TCP/TCPSocketWriter.cs | Updated CTS usage, added timeout handling, and refactored reconnection logic. |
| Serilog.Sinks.Network/Sinks/TCP/TCPSink.cs | Altered constructor overloads for improved dependency injection. |
| Serilog.Sinks.Network/NetworkLoggerConfigurationExtensions.cs | Revised parameter types and added timeout parameters. |
| Test Files | Updated tests to use free ports and consolidated UDP/TCP test files for clarity. |
| ServerPoller.cs | Improved asynchronous socket handling and added cancellation support. |
| PingPonger/Program.cs | Updated TCPSink invocations to include timeout parameters. |
Files not reviewed (1)
- Serilog.Sinks.Network/Serilog.Sinks.Network.csproj: Language not supported
Comments suppressed due to low confidence (1)
Serilog.Sinks.Network/Sinks/TCP/TCPSocketWriter.cs:222
- The null-check for _stream in FlushQueue indicates an unexpected state; consider revisiting the connection lifecycle to ensure _stream is consistently assigned or properly reinitialized.
if (_stream == null)
pauldambra
reviewed
Mar 29, 2025
pauldambra
reviewed
Mar 31, 2025
| @@ -49,6 +49,15 @@ public static LoggerConfiguration TCPSink( | |||
| return TCPSink(loggerConfiguration, $"tcp://{ipAddress}:{port}", writeTimeoutMs, disposeTimeoutMs, textFormatter, restrictedToMinimumLevel); | |||
| } | |||
|
|
|||
| public static LoggerConfiguration TCPSink( | |||
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hi @pauldambra ,
This is the key part we want to upstream!
It adds a timeout on Dispose/Flush so we avoid infinitely hanging.
Changes: