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

Jump to bottom

fix(iot-dev): Fix 3 multiplexing scenario bugs #1753

Merged
merged 2 commits into from
Oct 20, 2023
Merged

fix(iot-dev): Fix 3 multiplexing scenario bugs #1753

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cec2165
fix(iot-dev): Fix 2 multiplexing scenario bugs
timtay-microsoft Oct 19, 2023
f6ec9d3
Merge branch 'main' into timtay/muxFixes
timtay-microsoft Oct 20, 2023
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
56 changes: 55 additions & 1 deletion ...ce-client/src/main/java/com/microsoft/azure/sdk/iot/device/transport/IotHubTransport.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -410,7 +410,9 @@ public void onMultiplexedDeviceSessionEstablished(String connectionId, String de
@Override
public void onMultiplexedDeviceSessionLost(TransportException e, String connectionId, String deviceId, boolean shouldReconnect)
{
if (connectionId.equals(this.iotHubTransportConnection.getConnectionId()))
if (connectionId.equals(this.iotHubTransportConnection.getConnectionId())
&& multiplexedDeviceConnectionStates.containsKey(deviceId)
&& multiplexedDeviceConnectionStates.get(deviceId).getConnectionStatus() == IotHubConnectionStatus.CONNECTED)
{
log.debug("The device session in the multiplexed connection to the IoT Hub has been lost for device {}", deviceId);
if (shouldReconnect)
Expand Down Expand Up @@ -1388,6 +1390,7 @@ private void singleDeviceReconnectAttemptAsync(String deviceSessionToReconnect)
{
this.updateStatus(IotHubConnectionStatus.DISCONNECTED, IotHubConnectionStatusChangeReason.RETRY_EXPIRED, transportException, deviceSessionToReconnect);
log.debug("Reconnection for device {} was abandoned due to the operation timeout", deviceSessionToReconnect);
return;
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not returning here meant that retry logic would continue even if we declare that retry has expired

}

multiplexedDeviceState.incrementReconnectionAttemptNumber();
Expand All @@ -1406,6 +1409,7 @@ private void singleDeviceReconnectAttemptAsync(String deviceSessionToReconnect)
{
this.updateStatus(IotHubConnectionStatus.DISCONNECTED, IotHubConnectionStatusChangeReason.RETRY_EXPIRED, transportException, deviceSessionToReconnect);
log.debug("Reconnection for device {} was abandoned due to the retry policy", deviceSessionToReconnect);
return;
}

log.trace("Attempting to reconnect device session: attempt {}", multiplexedDeviceState.getReconnectionAttemptNumber());
Expand All @@ -1422,6 +1426,7 @@ private void singleDeviceReconnectAttemptAsync(String deviceSessionToReconnect)
{
this.updateStatus(IotHubConnectionStatus.DISCONNECTED, this.exceptionToStatusChangeReason(transportException), transportException, deviceSessionToReconnect);
log.error("Reconnection for device {} was abandoned due to encountering a non-retryable exception", deviceSessionToReconnect, transportException);
return;
}
}
}
Expand Down Expand Up @@ -1766,6 +1771,55 @@ private void updateStatus(IotHubConnectionStatus newConnectionStatus, IotHubConn
else if (newConnectionStatus == IotHubConnectionStatus.DISCONNECTED)
{
correlationCallbackCleanupThread.interrupt();
finalizeMultiplexedDevicesMessages(deviceId);
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Now when a multiplexed device reaches the DISCONNECTED state, we look for any of its messages in the outgoing queues and cancel them. This should address #1734

}
}

// When a multiplexed device has its session closed (expected or otherwise) all outgoing and pending
// messages should be removed and callbacks should be executed for each message to notify the user
// that the message was cancelled.
private void finalizeMultiplexedDevicesMessages(String deviceId)
{
//Check waiting packets, remove any that have expired.
IotHubTransportPacket packet = this.waitingPacketsQueue.poll();
Queue<IotHubTransportPacket> packetsToAddBackIntoWaitingPacketsQueue = new LinkedBlockingQueue<>();
while (packet != null)
{
if (packet.getMessage().getConnectionDeviceId().equals(deviceId))
{
packet.setStatus(IotHubStatusCode.MESSAGE_CANCELLED_ONCLOSE);
this.addToCallbackQueue(packet);
}
else
{
//message didn't belong to this device, requeue it
packetsToAddBackIntoWaitingPacketsQueue.add(packet);
}

packet = this.waitingPacketsQueue.poll();
}

//Requeue all the messages that belong to other devices.
this.waitingPacketsQueue.addAll(packetsToAddBackIntoWaitingPacketsQueue);

//Check in progress messages
synchronized (this.inProgressMessagesLock)
{
List<String> messageIdsThatBelongToDisconnectedDevice = new ArrayList<>();
for (String messageId : this.inProgressPackets.keySet())
{
if (this.inProgressPackets.get(messageId).getMessage().getConnectionDeviceId().equals(deviceId))
{
messageIdsThatBelongToDisconnectedDevice.add(messageId);
}
}

for (String messageId : messageIdsThatBelongToDisconnectedDevice)
{
IotHubTransportPacket expiredPacket = this.inProgressPackets.remove(messageId);
expiredPacket.setStatus(IotHubStatusCode.MESSAGE_CANCELLED_ONCLOSE);
this.addToCallbackQueue(expiredPacket);
}
}
}

Expand Down
Loading