Fix various disposable issues (#625)

* Fix various disposable issues This PR fixes various disposable issues * Fix * Do not dispose certificates * Build fixes * Build fixes * Build fixes * Fix review issues * Merge branch 'FixDisposable' of https://github.com/Bykiev/nats.net into FixDisposable * Sign --------- Co-authored-by: Ziya Suzen <ziya@suzen.net>
nats-io · Sep 4, 2024 · 323124a · 323124a
1 parent 426ea8c
commit 323124a
Show file tree

Hide file tree

Showing 9 changed files with 27 additions and 7 deletions.
diff --git a/src/NATS.Client.Core/Commands/ProtocolWriter.cs b/src/NATS.Client.Core/Commands/ProtocolWriter.cs
@@ -48,7 +48,7 @@ public void WriteConnect(IBufferWriter<byte> writer, ClientOpts opts)
         BinaryPrimitives.WriteUInt64LittleEndian(span, ConnectSpace);
         writer.Advance(ConnectSpaceLength);
 
-        var jsonWriter = new Utf8JsonWriter(writer);
+        using var jsonWriter = new Utf8JsonWriter(writer);
         JsonSerializer.Serialize(jsonWriter, opts, JsonContext.Default.ClientOpts);
 
         span = writer.GetSpan(UInt16Length);

diff --git a/src/NATS.Client.Core/Internal/SslStreamConnection.cs b/src/NATS.Client.Core/Internal/SslStreamConnection.cs
@@ -115,7 +115,11 @@ public void SignalDisconnected(Exception exception)
     public async Task AuthenticateAsClientAsync(NatsUri uri, TimeSpan timeout)
     {
         var options = await _tlsOpts.AuthenticateAsClientOptionsAsync(uri).ConfigureAwait(true);
+
 #if NETSTANDARD2_0
+        if (_sslStream != null)
+            _sslStream.Dispose();
+
         _sslStream = new SslStream(
             innerStream: new NetworkStream(_socket, true),
             leaveInnerStreamOpen: false,
@@ -134,6 +138,9 @@ await _sslStream.AuthenticateAsClientAsync(
             throw new NatsException($"TLS authentication failed", ex);
         }
 #else
+        if (_sslStream != null)
+            await _sslStream.DisposeAsync().ConfigureAwait(false);
+
         _sslStream = new SslStream(innerStream: new NetworkStream(_socket, true));
         try
         {

diff --git a/src/NATS.Client.Core/NKeyPair.cs b/src/NATS.Client.Core/NKeyPair.cs
@@ -72,6 +72,7 @@ public byte[] Sign(byte[] src)
     public void Dispose()
     {
         Dispose(true);
+        GC.SuppressFinalize(this);
     }
 
     /// <summary>
@@ -269,7 +270,7 @@ internal static string Encode(byte prefixbyte, bool seed, byte[] src)
         if (src.Length != 32)
             throw new NatsException("Invalid seed size");
 
-        var stream = new MemoryStream();
+        using var stream = new MemoryStream();
 
         if (seed)
         {

diff --git a/src/NATS.Client.Core/NatsConnection.cs b/src/NATS.Client.Core/NatsConnection.cs
@@ -848,7 +848,7 @@ private async void StartPingTimer(CancellationToken cancellationToken)
 
         _logger.LogDebug(NatsLogEvents.Connection, "Starting ping timer");
 
-        var periodicTimer = new PeriodicTimer(Opts.PingInterval);
+        using var periodicTimer = new PeriodicTimer(Opts.PingInterval);
         ResetPongCount();
         try
         {

diff --git a/src/NATS.Client.Core/NatsSubBase.cs b/src/NATS.Client.Core/NatsSubBase.cs
@@ -314,7 +314,7 @@ protected void ResetIdleTimeout()
         if (_startUpTimeoutTimer != null)
         {
             _startUpTimeoutTimer.Change(dueTime: Timeout.InfiniteTimeSpan, period: Timeout.InfiniteTimeSpan);
-            _startUpTimeoutTimer = null;
+            _startUpTimeoutTimer.Dispose();
         }
     }
 

diff --git a/src/NATS.Client.JetStream/Internal/NatsJSNotificationChannel.cs b/src/NATS.Client.JetStream/Internal/NatsJSNotificationChannel.cs
@@ -2,7 +2,7 @@
 
 namespace NATS.Client.JetStream.Internal;
 
-internal class NatsJSNotificationChannel : IAsyncDisposable
+internal sealed class NatsJSNotificationChannel : IAsyncDisposable
 {
     private readonly Func<INatsJSNotification, CancellationToken, Task> _notificationHandler;
     private readonly Action<Exception> _exceptionHandler;

diff --git a/src/NATS.Client.JetStream/Internal/NatsJSOrderedPushConsumer.cs b/src/NATS.Client.JetStream/Internal/NatsJSOrderedPushConsumer.cs
@@ -141,6 +141,12 @@ public async ValueTask DisposeAsync()
     {
         _nats.ConnectionDisconnected -= OnDisconnected;
 
+#if NETSTANDARD2_0
+        _timer.Dispose();
+#else
+        await _timer.DisposeAsync().ConfigureAwait(false);
+#endif
+
         // For correctly Dispose,
         // first stop the consumer Creation operations and then the command execution operations.
         // It is necessary that all consumerCreation operations have time to complete before command CommandLoop stop

diff --git a/src/NATS.Client.KeyValueStore/Internal/NatsKVWatcher.cs b/src/NATS.Client.KeyValueStore/Internal/NatsKVWatcher.cs
@@ -24,7 +24,7 @@ public NatsKVWatchCommandMsg()
     public NatsJSMsg<T> Msg { get; init; } = default;
 }
 
-internal class NatsKVWatcher<T> : IAsyncDisposable
+internal sealed class NatsKVWatcher<T> : IAsyncDisposable
 {
     private readonly ILogger _logger;
     private readonly bool _debug;
@@ -144,6 +144,12 @@ public async ValueTask DisposeAsync()
             await _sub.DisposeAsync();
         }
 
+#if NETSTANDARD2_0
+        _timer.Dispose();
+#else
+        await _timer.DisposeAsync().ConfigureAwait(false);
+#endif
+
         _consumerCreateChannel.Writer.TryComplete();
         _commandChannel.Writer.TryComplete();
         _entryChannel.Writer.TryComplete();

diff --git a/src/NATS.Client.ObjectStore/NatsObjStore.cs b/src/NATS.Client.ObjectStore/NatsObjStore.cs
@@ -52,7 +52,7 @@ internal NatsObjStore(NatsObjConfig config, NatsObjContext objContext, NatsJSCon
     /// <returns>Object value as a byte array.</returns>
     public async ValueTask<byte[]> GetBytesAsync(string key, CancellationToken cancellationToken = default)
     {
-        var memoryStream = new MemoryStream();
+        using var memoryStream = new MemoryStream();
         await GetAsync(key, memoryStream, cancellationToken: cancellationToken).ConfigureAwait(false);
         return memoryStream.ToArray();
     }