fix(iot-dev): Preserve response callback context#1847
Open
arnabnandy7 wants to merge 1 commit into
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Checklist
mainbranch.Reference/Link to the issue solved with this PR (if any)
Fixes #1803
Description of the problem
For correlated device client operations such as
getTwinAsyncandupdateReportedPropertiesAsync,onResponseReceivedcould be skipped in a race condition.In
IotHubTransport.onMessageReceived, the received message was added to the receive queue before the matchingCorrelationCallbackContextwas read fromcorrelationCallbacks. Adding the message to the queue wakes the receive task, which may acknowledge the message and remove the correlation callback beforeonMessageReceivedlooks it up. When that happens, the response callback is never invoked.Description of the solution
Capture the
CorrelationCallbackContextbefore adding the received message to the receive queue.onResponseReceivednow uses that saved context, so it still fires even if the receive task acknowledges the message and removes the callback entry immediately afterward.Added a regression unit test that simulates the correlation callback being removed while the received message is queued, and verifies that
onResponseReceivedis still called.