Updated code to use the ObjectDisposedException throw helper (#8322)

glen-84 · web-flow · commit 9af876c87c52 · 2025-05-30T15:16:19.000+02:00
diff --git a/.editorconfig b/.editorconfig
@@ -156,8 +156,11 @@ dotnet_diagnostic.CA1510.severity = warning
 dotnet_diagnostic.CA1511.severity = warning
 # Use ArgumentOutOfRangeException throw helper.
 dotnet_diagnostic.CA1512.severity = warning
+# Use ObjectDisposedException throw helper.
+dotnet_diagnostic.CA1513.severity = warning
 
 [src/HotChocolate/Language/**/*.cs]
 dotnet_diagnostic.CA1510.severity = none
 dotnet_diagnostic.CA1511.severity = none
 dotnet_diagnostic.CA1512.severity = none
+dotnet_diagnostic.CA1513.severity = none
diff --git a/src/HotChocolate/AspNetCore/src/AspNetCore/Subscriptions/OperationManager.cs b/src/HotChocolate/AspNetCore/src/AspNetCore/Subscriptions/OperationManager.cs
@@ -57,11 +57,7 @@ public bool Enqueue(string sessionId, GraphQLRequest request)
     {
         ArgumentException.ThrowIfNullOrEmpty(sessionId);
         ArgumentNullException.ThrowIfNull(request);
-
-        if (_disposed)
-        {
-            throw new ObjectDisposedException(nameof(OperationManager));
-        }
+        ObjectDisposedException.ThrowIf(_disposed, this);
 
         IOperationSession? session = null;
         _lock.EnterWriteLock();
@@ -93,11 +89,7 @@ public bool Enqueue(string sessionId, GraphQLRequest request)
     public bool Complete(string sessionId)
     {
         ArgumentException.ThrowIfNullOrEmpty(sessionId);
-
-        if (_disposed)
-        {
-            throw new ObjectDisposedException(nameof(OperationManager));
-        }
+        ObjectDisposedException.ThrowIf(_disposed, this);
 
         _lock.EnterWriteLock();
 
diff --git a/src/HotChocolate/AspNetCore/src/AspNetCore/Subscriptions/WebSocketConnection.cs b/src/HotChocolate/AspNetCore/src/AspNetCore/Subscriptions/WebSocketConnection.cs
@@ -39,10 +39,7 @@ public CancellationToken ApplicationStopping
 
     public async Task<IProtocolHandler?> TryAcceptConnection()
     {
-        if (_disposed)
-        {
-            throw new ObjectDisposedException(nameof(WebSocketConnection));
-        }
+        ObjectDisposedException.ThrowIf(_disposed, this);
 
         var webSocketManager = HttpContext.WebSockets;
 
diff --git a/src/HotChocolate/AspNetCore/src/Transport.Sockets.Client/Protocols/DataMessageObserver.cs b/src/HotChocolate/AspNetCore/src/Transport.Sockets.Client/Protocols/DataMessageObserver.cs
@@ -12,10 +12,7 @@ internal sealed class DataMessageObserver(string id) : IObserver<IOperationMessa
 
     public async ValueTask<IDataMessage?> TryReadNextAsync(CancellationToken ct)
     {
-        if (_disposed)
-        {
-            throw new ObjectDisposedException($"{nameof(DataMessageObserver)} is disposed.");
-        }
+        ObjectDisposedException.ThrowIf(_disposed, this);
 
         await _semaphore.WaitAsync(ct);
 
diff --git a/src/HotChocolate/Core/src/Abstractions/Execution/ExecutionResult.cs b/src/HotChocolate/Core/src/Abstractions/Execution/ExecutionResult.cs
@@ -40,10 +40,7 @@ public void RegisterForCleanup(Func<ValueTask> clean)
     /// </summary>
     protected void EnsureNotDisposed()
     {
-        if (_disposed)
-        {
-            throw new ObjectDisposedException(nameof(ResponseStream));
-        }
+        ObjectDisposedException.ThrowIf(_disposed, this);
     }
 
     /// <inheritdoc cref="IAsyncDisposable"/>
diff --git a/src/HotChocolate/Core/src/Execution/Processing/OperationContextOwner.cs b/src/HotChocolate/Core/src/Execution/Processing/OperationContextOwner.cs
@@ -33,10 +33,7 @@ public OperationContext OperationContext
     {
         get
         {
-            if (_disposed == 1)
-            {
-                throw new ObjectDisposedException(nameof(OperationContextOwner));
-            }
+            ObjectDisposedException.ThrowIf(_disposed == 1, this);
 
             return _context;
         }
diff --git a/src/HotChocolate/Core/src/Execution/RequestExecutorResolver.cs b/src/HotChocolate/Core/src/Execution/RequestExecutorResolver.cs
@@ -681,11 +681,7 @@ private sealed class EventObservable : IObservable<RequestExecutorEvent>, IDispo
 
         public IDisposable Subscribe(IObserver<RequestExecutorEvent> observer)
         {
-            if (_disposed)
-            {
-                throw new ObjectDisposedException(nameof(EventObservable));
-            }
-
+            ObjectDisposedException.ThrowIf(_disposed, this);
             ArgumentNullException.ThrowIfNull(observer);
 
             var subscription = new Subscription(this, observer);
@@ -700,10 +696,7 @@ public IDisposable Subscribe(IObserver<RequestExecutorEvent> observer)
 
         public void RaiseEvent(RequestExecutorEvent eventMessage)
         {
-            if (_disposed)
-            {
-                throw new ObjectDisposedException(nameof(EventObservable));
-            }
+            ObjectDisposedException.ThrowIf(_disposed, this);
 
             lock (_sync)
             {
diff --git a/src/HotChocolate/Core/src/Subscriptions.Postgres/AsyncAutoResetEvent.cs b/src/HotChocolate/Core/src/Subscriptions.Postgres/AsyncAutoResetEvent.cs
@@ -15,10 +15,7 @@ internal sealed class AsyncAutoResetEvent : IDisposable
 
     public Task WaitAsync(CancellationToken cancellationToken)
     {
-        if (_isDisposed)
-        {
-            throw new ObjectDisposedException(nameof(AsyncAutoResetEvent));
-        }
+        ObjectDisposedException.ThrowIf(_isDisposed, this);
 
         lock (_waitingTasks)
         {
@@ -36,10 +33,7 @@ public Task WaitAsync(CancellationToken cancellationToken)
 
     public void Set()
     {
-        if (_isDisposed)
-        {
-            throw new ObjectDisposedException(nameof(AsyncAutoResetEvent));
-        }
+        ObjectDisposedException.ThrowIf(_isDisposed, this);
 
         TaskCompletionSource<bool>? toRelease = null;
         lock (_waitingTasks)
diff --git a/src/HotChocolate/Core/src/Subscriptions.Postgres/AsyncTaskDispatcher.cs b/src/HotChocolate/Core/src/Subscriptions.Postgres/AsyncTaskDispatcher.cs
@@ -19,10 +19,7 @@ public AsyncTaskDispatcher(Func<CancellationToken, Task> handler)
 
     public async Task Initialize(CancellationToken cancellationToken)
     {
-        if (_disposed)
-        {
-            throw new ObjectDisposedException(nameof(AsyncTaskDispatcher));
-        }
+        ObjectDisposedException.ThrowIf(_disposed, this);
 
         if (_initialized)
         {
@@ -31,10 +28,7 @@ public async Task Initialize(CancellationToken cancellationToken)
 
         await _sync.WaitAsync(cancellationToken);
 
-        if (_disposed)
-        {
-            throw new ObjectDisposedException(nameof(AsyncTaskDispatcher));
-        }
+        ObjectDisposedException.ThrowIf(_disposed, this);
 
         if (_initialized)
         {
@@ -58,10 +52,7 @@ await _initialize.Task
 
     public void Dispatch()
     {
-        if (_disposed)
-        {
-            throw new ObjectDisposedException(nameof(AsyncTaskDispatcher));
-        }
+        ObjectDisposedException.ThrowIf(_disposed, this);
 
         _event.Set();
     }
diff --git a/src/HotChocolate/Core/src/Subscriptions.RabbitMQ/RabbitMQConnection.cs b/src/HotChocolate/Core/src/Subscriptions.RabbitMQ/RabbitMQConnection.cs
@@ -27,7 +27,7 @@ public RabbitMQConnection(ISubscriptionDiagnosticEvents diagnosticEvents, Connec
 
     public async Task<IModel> GetChannelAsync()
     {
-        ThrowIfDisposed();
+        ObjectDisposedException.ThrowIf(_disposed, this);
 
         if (_channel is not null)
         {
@@ -63,14 +63,6 @@ public void Dispose()
         _connection?.Dispose();
     }
 
-    private void ThrowIfDisposed()
-    {
-        if (_disposed)
-        {
-            throw new ObjectDisposedException(typeof(RabbitMQResources).FullName);
-        }
-    }
-
     private void InitializeConnection(ConnectionFactory connectionFactory)
         => InitializeConnectionAsync(connectionFactory).FireAndForget();
 
diff --git a/src/HotChocolate/Utilities/src/Utilities.Buffers/PooledArrayWriter.cs b/src/HotChocolate/Utilities/src/Utilities.Buffers/PooledArrayWriter.cs
@@ -73,11 +73,7 @@ public ReadOnlySpan<byte> GetWrittenSpan()
     /// </exception>
     public void Advance(int count)
     {
-        if (_disposed)
-        {
-            throw new ObjectDisposedException(nameof(PooledArrayWriter));
-        }
-
+        ObjectDisposedException.ThrowIf(_disposed, this);
         ArgumentOutOfRangeException.ThrowIfNegative(count);
 
         if (count > _capacity)
@@ -106,11 +102,7 @@ public void Advance(int count)
     /// </exception>
     public Memory<byte> GetMemory(int sizeHint = 0)
     {
-        if (_disposed)
-        {
-            throw new ObjectDisposedException(nameof(PooledArrayWriter));
-        }
-
+        ObjectDisposedException.ThrowIf(_disposed, this);
         ArgumentOutOfRangeException.ThrowIfNegative(sizeHint);
 
         var size = sizeHint < 1
@@ -134,11 +126,7 @@ public Memory<byte> GetMemory(int sizeHint = 0)
     /// </exception>
     public Span<byte> GetSpan(int sizeHint = 0)
     {
-        if (_disposed)
-        {
-            throw new ObjectDisposedException(nameof(PooledArrayWriter));
-        }
-
+        ObjectDisposedException.ThrowIf(_disposed, this);
         ArgumentOutOfRangeException.ThrowIfNegative(sizeHint);
 
         var size = sizeHint < 1 ? _initialBufferSize : sizeHint;
diff --git a/src/StrawberryShake/Client/src/Core/Internal/ArrayWriter.cs b/src/StrawberryShake/Client/src/Core/Internal/ArrayWriter.cs
@@ -71,11 +71,7 @@ public ReadOnlySpan<byte> GetWrittenSpan()
     /// </exception>
     public void Advance(int count)
     {
-        if (_disposed)
-        {
-            throw new ObjectDisposedException(nameof(ArrayWriter));
-        }
-
+        ObjectDisposedException.ThrowIf(_disposed, this);
         ArgumentOutOfRangeException.ThrowIfNegative(count);
 
         if (count > _capacity)
@@ -104,11 +100,7 @@ public void Advance(int count)
     /// </exception>
     public Memory<byte> GetMemory(int sizeHint = 0)
     {
-        if (_disposed)
-        {
-            throw new ObjectDisposedException(nameof(ArrayWriter));
-        }
-
+        ObjectDisposedException.ThrowIf(_disposed, this);
         ArgumentOutOfRangeException.ThrowIfNegative(sizeHint);
 
         var size = sizeHint < 1
@@ -132,11 +124,7 @@ public Memory<byte> GetMemory(int sizeHint = 0)
     /// </exception>
     public Span<byte> GetSpan(int sizeHint = 0)
     {
-        if (_disposed)
-        {
-            throw new ObjectDisposedException(nameof(ArrayWriter));
-        }
-
+        ObjectDisposedException.ThrowIf(_disposed, this);
         ArgumentOutOfRangeException.ThrowIfNegative(sizeHint);
 
         var size = sizeHint < 1
diff --git a/src/StrawberryShake/Client/src/Core/ObserverSession.cs b/src/StrawberryShake/Client/src/Core/ObserverSession.cs
@@ -28,10 +28,7 @@ public void SetStoreSession(IDisposable storeSession)
     {
         lock (_sync)
         {
-            if (_disposed)
-            {
-                throw new ObjectDisposedException(typeof(ObserverSession).FullName);
-            }
+            ObjectDisposedException.ThrowIf(_disposed, this);
 
             _storeSession = storeSession;
         }
diff --git a/src/StrawberryShake/Client/src/Core/OperationStore.cs b/src/StrawberryShake/Client/src/Core/OperationStore.cs
@@ -36,11 +36,7 @@ public void Set<T>(
     {
         ArgumentNullException.ThrowIfNull(operationRequest);
         ArgumentNullException.ThrowIfNull(operationResult);
-
-        if (_disposed)
-        {
-            throw new ObjectDisposedException(nameof(OperationStore));
-        }
+        ObjectDisposedException.ThrowIf(_disposed, this);
 
         var storedOperation = GetOrAddStoredOperation<T>(operationRequest);
         storedOperation.SetResult(operationResult);
@@ -57,11 +53,7 @@ public void Set(OperationRequest operationRequest, IOperationResult operationRes
     public void Reset(OperationRequest operationRequest)
     {
         ArgumentNullException.ThrowIfNull(operationRequest);
-
-        if (_disposed)
-        {
-            throw new ObjectDisposedException(nameof(OperationStore));
-        }
+        ObjectDisposedException.ThrowIf(_disposed, this);
 
         if (_results.TryGetValue(operationRequest, out var storedOperation))
         {
@@ -74,11 +66,7 @@ public void Reset(OperationRequest operationRequest)
     public void Remove(OperationRequest operationRequest)
     {
         ArgumentNullException.ThrowIfNull(operationRequest);
-
-        if (_disposed)
-        {
-            throw new ObjectDisposedException(nameof(OperationStore));
-        }
+        ObjectDisposedException.ThrowIf(_disposed, this);
 
         if (_results.TryRemove(operationRequest, out var storedOperation))
         {
@@ -90,10 +78,7 @@ public void Remove(OperationRequest operationRequest)
 
     public void Clear()
     {
-        if (_disposed)
-        {
-            throw new ObjectDisposedException(nameof(OperationStore));
-        }
+        ObjectDisposedException.ThrowIf(_disposed, this);
 
         var results = _results.Values;
         _results.Clear();
@@ -123,11 +108,7 @@ public bool TryGet<T>(
         where T : class
     {
         ArgumentNullException.ThrowIfNull(operationRequest);
-
-        if (_disposed)
-        {
-            throw new ObjectDisposedException(nameof(OperationStore));
-        }
+        ObjectDisposedException.ThrowIf(_disposed, this);
 
         if (_results.TryGetValue(operationRequest, out var storedOperation) &&
             storedOperation is StoredOperation<T> { LastResult: not null, } casted)
@@ -142,10 +123,7 @@ public bool TryGet<T>(
 
     public IEnumerable<StoredOperationVersion> GetAll()
     {
-        if (_disposed)
-        {
-            throw new ObjectDisposedException(nameof(OperationStore));
-        }
+        ObjectDisposedException.ThrowIf(_disposed, this);
 
         return _results.Values.Select(
             op => new StoredOperationVersion(
@@ -157,10 +135,7 @@ public IEnumerable<StoredOperationVersion> GetAll()
 
     public IReadOnlyList<EntityId> GetUsedEntityIds()
     {
-        if (_disposed)
-        {
-            throw new ObjectDisposedException(nameof(OperationStore));
-        }
+        ObjectDisposedException.ThrowIf(_disposed, this);
 
         return _results.Values.SelectMany(t => t.EntityIds).ToArray();
     }
@@ -170,21 +145,14 @@ public IObservable<IOperationResult<T>> Watch<T>(
         where T : class
     {
         ArgumentNullException.ThrowIfNull(operationRequest);
-
-        if (_disposed)
-        {
-            throw new ObjectDisposedException(nameof(OperationStore));
-        }
+        ObjectDisposedException.ThrowIf(_disposed, this);
 
         return GetOrAddStoredOperation<T>(operationRequest);
     }
 
     public IObservable<OperationUpdate> Watch()
     {
-        if (_disposed)
-        {
-            throw new ObjectDisposedException(nameof(OperationStore));
-        }
+        ObjectDisposedException.ThrowIf(_disposed, this);
 
         return _operationStoreObservable;
     }
diff --git a/src/StrawberryShake/Client/src/Transport.WebSockets/WebSocketClient.cs b/src/StrawberryShake/Client/src/Transport.WebSockets/WebSocketClient.cs

Original file line number	Diff line number	Diff line change
`@@ -39,10 +39,7 @@ public CancellationToken ApplicationStopping`
`39`	`39`
`40`	`40`	`public async Task<IProtocolHandler?> TryAcceptConnection()`
`41`	`41`	`{`
`42`		`- if (_disposed)`
`43`		`- {`
`44`		`- throw new ObjectDisposedException(nameof(WebSocketConnection));`
`45`		`- }`
	`42`	`+ ObjectDisposedException.ThrowIf(_disposed, this);`
`46`	`43`
`47`	`44`	`var webSocketManager = HttpContext.WebSockets;`
`48`	`45`
Original file line number	Diff line number	Diff line change
`@@ -12,10 +12,7 @@ internal sealed class DataMessageObserver(string id) : IObserver<IOperationMessa`
`12`	`12`
`13`	`13`	`public async ValueTask<IDataMessage?> TryReadNextAsync(CancellationToken ct)`
`14`	`14`	`{`
`15`		`- if (_disposed)`
`16`		`- {`
`17`		`- throw new ObjectDisposedException($"{nameof(DataMessageObserver)} is disposed.");`
`18`		`- }`
	`15`	`+ ObjectDisposedException.ThrowIf(_disposed, this);`
`19`	`16`
`20`	`17`	`await _semaphore.WaitAsync(ct);`
`21`	`18`
Original file line number	Diff line number	Diff line change
`@@ -40,10 +40,7 @@ public void RegisterForCleanup(Func<ValueTask> clean)`
`40`	`40`	`/// </summary>`
`41`	`41`	`protected void EnsureNotDisposed()`
`42`	`42`	`{`
`43`		`- if (_disposed)`
`44`		`- {`
`45`		`- throw new ObjectDisposedException(nameof(ResponseStream));`
`46`		`- }`
	`43`	`+ ObjectDisposedException.ThrowIf(_disposed, this);`
`47`	`44`	`}`
`48`	`45`
`49`	`46`	`/// <inheritdoc cref="IAsyncDisposable"/>`
Original file line number	Diff line number	Diff line change
`@@ -33,10 +33,7 @@ public OperationContext OperationContext`
`33`	`33`	`{`
`34`	`34`	`get`
`35`	`35`	`{`
`36`		`- if (_disposed == 1)`
`37`		`- {`
`38`		`- throw new ObjectDisposedException(nameof(OperationContextOwner));`
`39`		`- }`
	`36`	`+ ObjectDisposedException.ThrowIf(_disposed == 1, this);`
`40`	`37`
`41`	`38`	`return _context;`
`42`	`39`	`}`
Original file line number	Diff line number	Diff line change
`@@ -15,10 +15,7 @@ internal sealed class AsyncAutoResetEvent : IDisposable`
`15`	`15`
`16`	`16`	`public Task WaitAsync(CancellationToken cancellationToken)`
`17`	`17`	`{`
`18`		`- if (_isDisposed)`
`19`		`- {`
`20`		`- throw new ObjectDisposedException(nameof(AsyncAutoResetEvent));`
`21`		`- }`
	`18`	`+ ObjectDisposedException.ThrowIf(_isDisposed, this);`
`22`	`19`
`23`	`20`	`lock (_waitingTasks)`
`24`	`21`	`{`
`@@ -36,10 +33,7 @@ public Task WaitAsync(CancellationToken cancellationToken)`
`36`	`33`
`37`	`34`	`public void Set()`
`38`	`35`	`{`
`39`		`- if (_isDisposed)`
`40`		`- {`
`41`		`- throw new ObjectDisposedException(nameof(AsyncAutoResetEvent));`
`42`		`- }`
	`36`	`+ ObjectDisposedException.ThrowIf(_isDisposed, this);`
`43`	`37`
`44`	`38`	`TaskCompletionSource<bool>? toRelease = null;`
`45`	`39`	`lock (_waitingTasks)`
Original file line number	Diff line number	Diff line change
`@@ -19,10 +19,7 @@ public AsyncTaskDispatcher(Func<CancellationToken, Task> handler)`
`19`	`19`
`20`	`20`	`public async Task Initialize(CancellationToken cancellationToken)`
`21`	`21`	`{`
`22`		`- if (_disposed)`
`23`		`- {`
`24`		`- throw new ObjectDisposedException(nameof(AsyncTaskDispatcher));`
`25`		`- }`
	`22`	`+ ObjectDisposedException.ThrowIf(_disposed, this);`
`26`	`23`
`27`	`24`	`if (_initialized)`
`28`	`25`	`{`
`@@ -31,10 +28,7 @@ public async Task Initialize(CancellationToken cancellationToken)`
`31`	`28`
`32`	`29`	`await _sync.WaitAsync(cancellationToken);`
`33`	`30`
`34`		`- if (_disposed)`
`35`		`- {`
`36`		`- throw new ObjectDisposedException(nameof(AsyncTaskDispatcher));`
`37`		`- }`
	`31`	`+ ObjectDisposedException.ThrowIf(_disposed, this);`
`38`	`32`
`39`	`33`	`if (_initialized)`
`40`	`34`	`{`
`@@ -58,10 +52,7 @@ await _initialize.Task`
`58`	`52`
`59`	`53`	`public void Dispatch()`
`60`	`54`	`{`
`61`		`- if (_disposed)`
`62`		`- {`
`63`		`- throw new ObjectDisposedException(nameof(AsyncTaskDispatcher));`
`64`		`- }`
	`55`	`+ ObjectDisposedException.ThrowIf(_disposed, this);`
`65`	`56`
`66`	`57`	`_event.Set();`
`67`	`58`	`}`
Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@ public RabbitMQConnection(ISubscriptionDiagnosticEvents diagnosticEvents, Connec`
`27`	`27`
`28`	`28`	`public async Task<IModel> GetChannelAsync()`
`29`	`29`	`{`
`30`		`- ThrowIfDisposed();`
	`30`	`+ ObjectDisposedException.ThrowIf(_disposed, this);`
`31`	`31`
`32`	`32`	`if (_channel is not null)`
`33`	`33`	`{`
`@@ -63,14 +63,6 @@ public void Dispose()`
`63`	`63`	`_connection?.Dispose();`
`64`	`64`	`}`
`65`	`65`
`66`		`- private void ThrowIfDisposed()`
`67`		`- {`
`68`		`- if (_disposed)`
`69`		`- {`
`70`		`- throw new ObjectDisposedException(typeof(RabbitMQResources).FullName);`
`71`		`- }`
`72`		`- }`
`73`		`-`
`74`	`66`	`private void InitializeConnection(ConnectionFactory connectionFactory)`
`75`	`67`	`=> InitializeConnectionAsync(connectionFactory).FireAndForget();`
`76`	`68`