Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Avoid NRE and disposed exceptions when closing client twice #3312

Merged
merged 1 commit into from
Apr 28, 2023
Merged

Avoid NRE and disposed exceptions when closing client twice #3312

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 44 additions & 0 deletions e2e/test/iothub/DeviceClientE2eTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
// Copyright (c) Microsoft. All rights reserved.
// Licensed under the MIT license. See LICENSE file in the project root for full license information.

using System;
using System.Threading.Tasks;
using FluentAssertions;
using Microsoft.Azure.Devices.E2ETests.Helpers;
using Microsoft.VisualStudio.TestTools.UnitTesting;

namespace Microsoft.Azure.Devices.E2ETests
{
[TestClass]
[TestCategory("E2E")]
[TestCategory("IoTHub")]
public class DeviceClientE2eTests
{
[TestMethod]
public async Task DeviceClient_CloseAsync_CanBeCalledTwice()
{
// arrange

using TestDevice testDevice = await TestDevice.GetTestDeviceAsync(nameof(DeviceClient_CloseAsync_CanBeCalledTwice));

try
{
using Client.DeviceClient client = testDevice.CreateDeviceClient(Client.TransportType.Amqp_Tcp_Only);
await client.OpenAsync().ConfigureAwait(false);
await client.CloseAsync().ConfigureAwait(false);

// act
Func<Task> act = () => client.CloseAsync();

// assert
await act.Should().NotThrowAsync().ConfigureAwait(false);
}
finally
{
await testDevice.RemoveDeviceAsync().ConfigureAwait(false);
testDevice.Dispose();
drwill-ms marked this conversation as resolved.
Show resolved Hide resolved
}

}
}
}
23 changes: 11 additions & 12 deletions iothub/device/src/Pipeline/RetryDelegatingHandler.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -784,16 +784,17 @@ public override async Task CloseAsync(CancellationToken cancellationToken)
{
try
{
if (!_openCalled)
if (!_openCalled
|| GetClientTransportStatus() == ClientTransportStatus.Closed)
{
return;
}

if (Logging.IsEnabled)
Logging.Enter(this, cancellationToken, nameof(CloseAsync));

_handleDisconnectCts.Cancel();
_cancelPendingOperationsCts.Cancel();
_handleDisconnectCts?.Cancel();
drwill-ms marked this conversation as resolved.
Show resolved Hide resolved
_cancelPendingOperationsCts?.Cancel();
await base.CloseAsync(cancellationToken).ConfigureAwait(false);
}
finally
Expand Down Expand Up @@ -859,7 +860,7 @@ private async Task EnsureOpenedAsync(bool withRetry, CancellationToken cancellat
if (Logging.IsEnabled)
Logging.Info(this, "Race condition: Disposed during opening.", nameof(EnsureOpenedAsync));

_handleDisconnectCts.Cancel();
_handleDisconnectCts?.Cancel();
}
}
}
Expand Down Expand Up @@ -930,7 +931,7 @@ private async Task EnsureOpenedAsync(bool withRetry, TimeoutHelper timeoutHelper
if (Logging.IsEnabled)
Logging.Info(this, "Race condition: Disposed during opening.", nameof(EnsureOpenedAsync));

_handleDisconnectCts.Cancel();
_handleDisconnectCts?.Cancel();
}
}
}
Expand Down Expand Up @@ -1071,7 +1072,7 @@ private async Task HandleDisconnectAsync()
if (Logging.IsEnabled)
Logging.Info(this, "Disposed during disconnection.", nameof(HandleDisconnectAsync));

_handleDisconnectCts.Cancel();
_handleDisconnectCts?.Cancel();
}

try
Expand Down Expand Up @@ -1114,7 +1115,7 @@ private async Task HandleDisconnectAsync()

// always reconnect.
_onConnectionStatusChanged(ConnectionStatus.Disconnected_Retrying, ConnectionStatusChangeReason.Communication_Error);
CancellationToken cancellationToken = _handleDisconnectCts.Token;
CancellationToken cancellationToken = _handleDisconnectCts?.Token ?? CancellationToken.None;

// This will recover to the state before the disconnect.
await _internalRetryPolicy.RunWithRetryAsync(async () =>
Expand Down Expand Up @@ -1253,9 +1254,7 @@ protected override void Dispose(bool disposing)
try
{
if (Logging.IsEnabled)
{
Logging.Enter(this, $"{nameof(DefaultDelegatingHandler)}.Disposed={_isDisposed}; disposing={disposing}", $"{nameof(RetryDelegatingHandler)}.{nameof(Dispose)}");
}

if (!_isDisposed)
{
Expand All @@ -1266,6 +1265,9 @@ protected override void Dispose(bool disposing)

if (disposing)
{
_handleDisconnectCts?.Cancel();
_cancelPendingOperationsCts?.Cancel();

var disposables = new List<IDisposable>
{
_handleDisconnectCts,
Expand All @@ -1277,9 +1279,6 @@ protected override void Dispose(bool disposing)
_twinEventsSubscriptionSemaphore,
};

_handleDisconnectCts?.Cancel();
_cancelPendingOperationsCts?.Cancel();

foreach (IDisposable disposable in disposables)
{
try
Expand Down