refactor : use new ThrowIf overload of ObjectDisposedException (#…

…42613) Co-authored-by: James Newton-King <james@newtonking.com>
dotnet · Jul 16, 2022 · f6362e0 · f6362e0
1 parent 27939db
commit f6362e0
Show file tree

Hide file tree

Showing 21 changed files with 39 additions and 149 deletions.
diff --git a/src/Components/Components/src/OwningComponentBase.cs b/src/Components/Components/src/OwningComponentBase.cs
@@ -37,10 +37,7 @@ protected IServiceProvider ScopedServices
                 throw new InvalidOperationException("Services cannot be accessed before the component is initialized.");
             }
 
-            if (IsDisposed)
-            {
-                throw new ObjectDisposedException(GetType().Name);
-            }
+            ObjectDisposedException.ThrowIf(IsDisposed, this);
 
             _scope ??= ScopeFactory.CreateAsyncScope();
             return _scope.Value.ServiceProvider;
@@ -85,10 +82,7 @@ protected TService Service
     {
         get
         {
-            if (IsDisposed)
-            {
-                throw new ObjectDisposedException(GetType().Name);
-            }
+            ObjectDisposedException.ThrowIf(IsDisposed, this);
 
             // We cache this because we don't know the lifetime. We have to assume that it could be transient.
             _item ??= ScopedServices.GetRequiredService<TService>();

diff --git a/src/Components/Shared/src/ArrayBuilder.cs b/src/Components/Shared/src/ArrayBuilder.cs
@@ -174,10 +174,7 @@ protected void GrowBuffer(int desiredCapacity)
         // If someone tries to do something that would require non-zero storage then
         // this is a use-after-free. Throwing here is an easy way to prevent that without
         // introducing overhead to every method.
-        if (_disposed)
-        {
-            ThrowObjectDisposedException();
-        }
+        ObjectDisposedException.ThrowIf(_disposed, null);
 
         var newCapacity = Math.Max(desiredCapacity, _minCapacity);
         Debug.Assert(newCapacity > _items.Length);
@@ -216,9 +213,4 @@ private static void ThrowIndexOutOfBoundsException()
     {
         throw new ArgumentOutOfRangeException("index");
     }
-
-    private static void ThrowObjectDisposedException()
-    {
-        throw new ObjectDisposedException(objectName: null);
-    }
 }
diff --git a/src/Hosting/TestHost/src/TestServer.cs b/src/Hosting/TestHost/src/TestServer.cs
@@ -252,10 +252,7 @@ Task IServer.StartAsync<TContext>(IHttpApplication<TContext> application, Cancel
     {
         _application = new ApplicationWrapper<TContext>(application, () =>
         {
-            if (_disposed)
-            {
-                throw new ObjectDisposedException(GetType().FullName);
-            }
+            ObjectDisposedException.ThrowIf(_disposed, this);
         });
 
         return Task.CompletedTask;

diff --git a/src/Hosting/TestHost/src/TestWebSocket.cs b/src/Hosting/TestHost/src/TestWebSocket.cs
@@ -172,10 +172,7 @@ private void Close()
 
     private void ThrowIfDisposed()
     {
-        if (_state >= WebSocketState.Closed) // or Aborted
-        {
-            throw new ObjectDisposedException(typeof(TestWebSocket).FullName);
-        }
+        ObjectDisposedException.ThrowIf(_state >= WebSocketState.Closed, typeof(TestWebSocket)); // or Aborted
     }
 
     private void ThrowIfOutputClosed()
@@ -282,10 +279,8 @@ public Task SendAsync(Message message)
         {
             lock (_messageQueue)
             {
-                if (_senderClosed)
-                {
-                    throw new ObjectDisposedException(typeof(TestWebSocket).FullName);
-                }
+                ObjectDisposedException.ThrowIf(_senderClosed, typeof(TestWebSocket));
+
                 if (_receiverClosed)
                 {
                     throw new IOException("The remote end closed the connection.", new ObjectDisposedException(typeof(TestWebSocket).FullName));
@@ -335,14 +330,10 @@ public void SetSenderClosed()
 
         private void ThrowNoReceive()
         {
-            if (_receiverClosed)
-            {
-                throw new ObjectDisposedException(typeof(TestWebSocket).FullName);
-            }
-            else // _senderClosed
-            {
-                throw new IOException("The remote end closed the connection.", new ObjectDisposedException(typeof(TestWebSocket).FullName));
-            }
+            ObjectDisposedException.ThrowIf(_receiverClosed, typeof(TestWebSocket));
+
+            // _senderClosed must be true.
+            throw new IOException("The remote end closed the connection.", new ObjectDisposedException(typeof(TestWebSocket).FullName));
         }
     }
 }
diff --git a/src/Http/Http/src/Internal/ReferenceReadStream.cs b/src/Http/Http/src/Internal/ReferenceReadStream.cs
@@ -150,9 +150,6 @@ protected override void Dispose(bool disposing)
 
     private void ThrowIfDisposed()
     {
-        if (_disposed)
-        {
-            throw new ObjectDisposedException(nameof(ReferenceReadStream));
-        }
+        ObjectDisposedException.ThrowIf(_disposed, nameof(ReferenceReadStream));
     }
 }
diff --git a/src/Http/WebUtilities/src/BufferedReadStream.cs b/src/Http/WebUtilities/src/BufferedReadStream.cs
@@ -419,10 +419,7 @@ private static string DecodeLine(MemoryStream builder, bool foundCRLF)
 
     private void CheckDisposed()
     {
-        if (_disposed)
-        {
-            throw new ObjectDisposedException(nameof(BufferedReadStream));
-        }
+        ObjectDisposedException.ThrowIf(_disposed, nameof(BufferedReadStream));
     }
 
     private static void ValidateBuffer(byte[] buffer, int offset, int count)

diff --git a/src/Http/WebUtilities/src/FileBufferingReadStream.cs b/src/Http/WebUtilities/src/FileBufferingReadStream.cs
@@ -502,9 +502,6 @@ public override async ValueTask DisposeAsync()
 
     private void ThrowIfDisposed()
     {
-        if (_disposed)
-        {
-            throw new ObjectDisposedException(nameof(FileBufferingReadStream));
-        }
+        ObjectDisposedException.ThrowIf(_disposed, nameof(FileBufferingReadStream));
     }
 }
diff --git a/src/Http/WebUtilities/src/FileBufferingWriteStream.cs b/src/Http/WebUtilities/src/FileBufferingWriteStream.cs
@@ -283,18 +283,12 @@ private void EnsureFileStream()
 
     private void ThrowIfDisposed()
     {
-        if (Disposed)
-        {
-            throw new ObjectDisposedException(nameof(FileBufferingWriteStream));
-        }
+        ObjectDisposedException.ThrowIf(Disposed, nameof(FileBufferingWriteStream));
     }
 
     private static void ThrowArgumentException(byte[] buffer, int offset, int count)
     {
-        if (buffer == null)
-        {
-            throw new ArgumentNullException(nameof(buffer));
-        }
+        ArgumentNullException.ThrowIfNull(buffer);
 
         if (offset < 0)
         {

diff --git a/src/Http/WebUtilities/src/HttpRequestStreamReader.cs b/src/Http/WebUtilities/src/HttpRequestStreamReader.cs
@@ -123,10 +123,7 @@ protected override void Dispose(bool disposing)
     /// <inheritdoc />
     public override int Peek()
     {
-        if (_disposed)
-        {
-            throw new ObjectDisposedException(nameof(HttpRequestStreamReader));
-        }
+        ObjectDisposedException.ThrowIf(_disposed, nameof(HttpRequestStreamReader));
 
         if (_charBufferIndex == _charsRead)
         {
@@ -142,10 +139,7 @@ public override int Peek()
     /// <inheritdoc />
     public override int Read()
     {
-        if (_disposed)
-        {
-            throw new ObjectDisposedException(nameof(HttpRequestStreamReader));
-        }
+        ObjectDisposedException.ThrowIf(_disposed, nameof(HttpRequestStreamReader));
 
         if (_charBufferIndex == _charsRead)
         {
@@ -188,10 +182,7 @@ public override int Read(Span<char> buffer)
             throw new ArgumentNullException(nameof(buffer));
         }
 
-        if (_disposed)
-        {
-            throw new ObjectDisposedException(nameof(HttpRequestStreamReader));
-        }
+        ObjectDisposedException.ThrowIf(_disposed, nameof(HttpRequestStreamReader));
 
         var count = buffer.Length;
         var charsRead = 0;
@@ -260,10 +251,7 @@ public override Task<int> ReadAsync(char[] buffer, int index, int count)
     [SuppressMessage("ApiDesign", "RS0027:Public API with optional parameter(s) should have the most parameters amongst its public overloads.", Justification = "Required to maintain compatibility")]
     public override async ValueTask<int> ReadAsync(Memory<char> buffer, CancellationToken cancellationToken = default)
     {
-        if (_disposed)
-        {
-            throw new ObjectDisposedException(nameof(HttpRequestStreamReader));
-        }
+        ObjectDisposedException.ThrowIf(_disposed, nameof(HttpRequestStreamReader));
 
         if (_charBufferIndex == _charsRead && await ReadIntoBufferAsync() == 0)
         {
@@ -353,10 +341,7 @@ public override async ValueTask<int> ReadAsync(Memory<char> buffer, Cancellation
     /// <inheritdoc />
     public override async Task<string?> ReadLineAsync()
     {
-        if (_disposed)
-        {
-            throw new ObjectDisposedException(nameof(HttpRequestStreamReader));
-        }
+        ObjectDisposedException.ThrowIf(_disposed, nameof(HttpRequestStreamReader));
 
         StringBuilder? sb = null;
         var consumeLineFeed = false;
@@ -391,10 +376,7 @@ public override async ValueTask<int> ReadAsync(Memory<char> buffer, Cancellation
     /// <inheritdoc />
     public override string? ReadLine()
     {
-        if (_disposed)
-        {
-            throw new ObjectDisposedException(nameof(HttpRequestStreamReader));
-        }
+        ObjectDisposedException.ThrowIf(_disposed, nameof(HttpRequestStreamReader));
 
         StringBuilder? sb = null;
         var consumeLineFeed = false;

diff --git a/src/Http/WebUtilities/src/HttpResponseStreamWriter.cs b/src/Http/WebUtilities/src/HttpResponseStreamWriter.cs
@@ -108,10 +108,7 @@ public HttpResponseStreamWriter(
     /// <inheritdoc/>
     public override void Write(char value)
     {
-        if (_disposed)
-        {
-            throw new ObjectDisposedException(nameof(HttpResponseStreamWriter));
-        }
+        ObjectDisposedException.ThrowIf(_disposed, nameof(HttpResponseStreamWriter));
 
         if (_charBufferCount == _charBufferSize)
         {
@@ -125,10 +122,7 @@ public override void Write(char value)
     /// <inheritdoc/>
     public override void Write(char[] values, int index, int count)
     {
-        if (_disposed)
-        {
-            throw new ObjectDisposedException(nameof(HttpResponseStreamWriter));
-        }
+        ObjectDisposedException.ThrowIf(_disposed, nameof(HttpResponseStreamWriter));
 
         if (values == null)
         {
@@ -149,10 +143,7 @@ public override void Write(char[] values, int index, int count)
     /// <inheritdoc/>
     public override void Write(ReadOnlySpan<char> value)
     {
-        if (_disposed)
-        {
-            throw new ObjectDisposedException(nameof(HttpResponseStreamWriter));
-        }
+        ObjectDisposedException.ThrowIf(_disposed, nameof(HttpResponseStreamWriter));
 
         var remaining = value.Length;
         while (remaining > 0)
@@ -172,10 +163,7 @@ public override void Write(ReadOnlySpan<char> value)
     /// <inheritdoc/>
     public override void Write(string? value)
     {
-        if (_disposed)
-        {
-            throw new ObjectDisposedException(nameof(HttpResponseStreamWriter));
-        }
+        ObjectDisposedException.ThrowIf(_disposed, nameof(HttpResponseStreamWriter));
 
         if (value == null)
         {
@@ -198,10 +186,7 @@ public override void Write(string? value)
     /// <inheritdoc/>
     public override void WriteLine(ReadOnlySpan<char> value)
     {
-        if (_disposed)
-        {
-            throw new ObjectDisposedException(nameof(HttpResponseStreamWriter));
-        }
+        ObjectDisposedException.ThrowIf(_disposed, nameof(HttpResponseStreamWriter));
 
         Write(value);
         Write(NewLine);
@@ -523,10 +508,7 @@ private async Task WriteLineAsyncAwaited(string value)
     /// <inheritdoc/>
     public override void Flush()
     {
-        if (_disposed)
-        {
-            throw new ObjectDisposedException(nameof(HttpResponseStreamWriter));
-        }
+        ObjectDisposedException.ThrowIf(_disposed, nameof(HttpResponseStreamWriter));
 
         FlushInternal(flushEncoder: true);
     }

diff --git a/src/Http/WebUtilities/src/PagedByteBuffer.cs b/src/Http/WebUtilities/src/PagedByteBuffer.cs
@@ -136,9 +136,6 @@ private void ClearBuffers()
 
     private void ThrowIfDisposed()
     {
-        if (Disposed)
-        {
-            throw new ObjectDisposedException(nameof(PagedByteBuffer));
-        }
+        ObjectDisposedException.ThrowIf(Disposed, nameof(PagedByteBuffer));
     }
 }
diff --git a/src/Identity/EntityFrameworkCore/src/RoleStore.cs b/src/Identity/EntityFrameworkCore/src/RoleStore.cs
@@ -346,10 +346,7 @@ protected virtual async Task SaveChanges(CancellationToken cancellationToken)
     /// </summary>
     protected void ThrowIfDisposed()
     {
-        if (_disposed)
-        {
-            throw new ObjectDisposedException(GetType().Name);
-        }
+        ObjectDisposedException.ThrowIf(_disposed, this);
     }
 
     /// <summary>

diff --git a/src/JSInterop/Microsoft.JSInterop/src/DotNetObjectReferenceOfT.cs b/src/JSInterop/Microsoft.JSInterop/src/DotNetObjectReferenceOfT.cs
@@ -97,9 +97,6 @@ public void Dispose()
 
     internal void ThrowIfDisposed()
     {
-        if (Disposed)
-        {
-            throw new ObjectDisposedException(GetType().Name);
-        }
+        ObjectDisposedException.ThrowIf(Disposed, this);
     }
 }
diff --git a/src/JSInterop/Microsoft.JSInterop/src/Implementation/JSObjectReference.cs b/src/JSInterop/Microsoft.JSInterop/src/Implementation/JSObjectReference.cs
@@ -62,9 +62,6 @@ public async ValueTask DisposeAsync()
     /// <inheritdoc />
     protected void ThrowIfDisposed()
     {
-        if (Disposed)
-        {
-            throw new ObjectDisposedException(GetType().Name);
-        }
+        ObjectDisposedException.ThrowIf(Disposed, this);
     }
 }
diff --git a/src/Middleware/Spa/SpaServices.Extensions/test/ListLoggerFactory.cs b/src/Middleware/Spa/SpaServices.Extensions/test/ListLoggerFactory.cs
@@ -46,10 +46,7 @@ public virtual ILogger CreateLogger(string name)
 
     private void CheckDisposed()
     {
-        if (_disposed)
-        {
-            throw new ObjectDisposedException(nameof(ListLoggerFactory));
-        }
+        ObjectDisposedException.ThrowIf(_disposed, nameof(ListLoggerFactory));
     }
 
     public void AddProvider(ILoggerProvider provider)

diff --git a/src/Middleware/WebSockets/test/UnitTests/BufferStream.cs b/src/Middleware/WebSockets/test/UnitTests/BufferStream.cs
@@ -338,9 +338,6 @@ protected override void Dispose(bool disposing)
 
     private void CheckDisposed()
     {
-        if (_disposed)
-        {
-            throw new ObjectDisposedException(GetType().FullName);
-        }
+        ObjectDisposedException.ThrowIf(_disposed, this);
     }
 }
diff --git a/src/Servers/HttpSys/src/HttpSysListener.cs b/src/Servers/HttpSys/src/HttpSysListener.cs
@@ -418,9 +418,6 @@ internal unsafe void SendError(ulong requestId, int httpStatusCode, IList<string
 
     private void CheckDisposed()
     {
-        if (_state == State.Disposed)
-        {
-            throw new ObjectDisposedException(this.GetType().FullName);
-        }
+        ObjectDisposedException.ThrowIf(_state == State.Disposed, this);
     }
 }
diff --git a/src/Servers/HttpSys/src/NativeInterop/RequestQueue.cs b/src/Servers/HttpSys/src/NativeInterop/RequestQueue.cs
@@ -148,10 +148,7 @@ public void Dispose()
 
     private void CheckDisposed()
     {
-        if (_disposed)
-        {
-            throw new ObjectDisposedException(this.GetType().FullName);
-        }
+        ObjectDisposedException.ThrowIf(_disposed, this);
     }
 
     private static partial class Log