Implement stream management requesting ACKs #1005
Conversation
Queue outgoing stanzas and periodically request ACK. Remove from the queue anything ack'd and notify of the ack so apps can know the stanza has for sure sent. On resume, anything not ack'd is re-sent. On reconnect, anything not ack'd notify of the failure to send this stanza so apps can know the stanza failed. Even when there is no traffic, send an <r/> at least every 5 minutes to check the connection. If there is no inbound traffic (such as an <a/>) within timeout (default 60 seconds) then consider the connection disconnected.
There was a problem hiding this comment.
Thank you
Tests are needed, in particular because this implements quite a complex behavior
In general I try to avoid "internal" XMPP events on entity . They also don't appear to be used. Are they needed? What for and in which case they should be documented. Possibly also emitted on the object returned by function streamManagement
| @@ -2,6 +2,7 @@ | |||
|
|
|||
| const Element = require("ltx/lib/Element"); | |||
| const createElement = require("ltx/lib/createElement"); | |||
| const clone = require("ltx/lib/clone"); | |||
There was a problem hiding this comment.
clone is not exported on purpose from @xmpp/xml to keep the size to a minimum
| qStanza.name === "message" && | ||
| !qStanza.getChild("delay", "urn:xmpp:delay") | ||
| ) { | ||
| qStanza = xml.clone(stanza); |
There was a problem hiding this comment.
wdyt of not cloning the stanza? I think we can document that we don't guarantee immutability past send()
There was a problem hiding this comment.
Hmm, any mutation of arguments to a library that is visible by the caller makes my uncomfortable, and I'm not sure avoiding it just to lose 1KB is worth it IMO. But I don't think it would actually break anything I'm using it for, so if you feel strongly we should drop the clone I could I think.
| @@ -52,7 +52,7 @@ | |||
| "bundlesize": [ | |||
| { | |||
| "path": "./packages/client/dist/xmpp.min.js", | |||
| "maxSize": "16 KB" | |||
| "maxSize": "17 KB" | |||
There was a problem hiding this comment.
needed if we're gonna make use of clone
Yes I am using these events in the snikket SDK to eg know when a message has been acknowledged or not, so I can update my state to know if it made it to the server. Most apps even show this status information (eg one check in conversations means "stream management ack") |
Queue outgoing stanzas and periodically request ACK. Remove from the queue anything ack'd and notify of the ack so apps can know the stanza has for sure sent.
On resume, anything not ack'd is re-sent. On reconnect, anything not ack'd notify of the failure to send this stanza so apps can know the stanza failed.
Even when there is no traffic, send an at least every 5 minutes to check the connection. If there is no inbound traffic (such as an ) within timeout (default 60 seconds) then consider the connection disconnected.