Improve ACK handling: pass to onAckNak and on request in sendData
#602
Conversation
This file contains 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
… add a mechanism for other handlers to request acks as well.
ianmcorvidae
commented
Jun 20, 2024
Comment on lines
+1142
to
+1148
| # we keep the responseHandler in dict until we actually call it | ||
| handler = self.responseHandlers.get(requestId, None) | ||
| if handler is not None: | ||
| if (not isAck) or handler.callback.__name__ == "onAckNak" or handler.ackPermitted: | ||
| handler = self.responseHandlers.pop(requestId, None) | ||
| logging.debug(f"Calling response handler for requestId {requestId}") | ||
| handler.callback(asDict) |
There was a problem hiding this comment.
(this is the change that fixes the bug -- previously we were not checking for onAckNak before shortcutting out of the handler in line 1135. This instead fetches the handler and checks if it should pass acks to it, but only removes it from the handlers if it decides it should)
ianmcorvidae
commented
Jun 20, 2024
Comment on lines
+319
to
+322
| onResponseAckPermitted -- should the onResponse callback be called | ||
| for regular ACKs (True) or just data responses & NAKs (False) | ||
| Note that if the onResponse callback is called 'onAckNak' this | ||
| will implicitly be true. |
There was a problem hiding this comment.
Right now this is only added to sendData, but I will try to go through and add it to other helpers too, for library users' sake.
|
I'm not sure why codecov is complaining, but everything else seems fine, so I'll go ahead and merge anyway I think. |
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.
correctly pass them to
onAckNakhandlers, and add a mechanism for other handlers to request acks as well.issue discovered looking at #594; not marking that fully closed though, because there's still an improvement to be made there in having implicit ACKs be ignored if a full ack desired/expected