quickblox 2.24.0-beta.1 → 2.24.0

package/src/modules/chat/qbChat.js

@@ -2473,10 +2473,8 @@ ChatProxy.prototype = {
      *
      * TODO(2.25.0): make auto-enable SDK-internal — fire on initial connect and
      * on relogin after session-expired, skip on Stream-Management reconnect.
-     * Spec & three-state matrix:
-     *   __ai-work-log/sdk-js/tasks/ad-hoc-2026-05-05-notice-reaction-admin-role/
-     *     backlog-2.25.0-auto-enable-notices.md
-     *     jira-stories/_jira-src-06-auto-enable-notices.md
+     * Spec & three-state matrix are tracked in the internal 2.25.0 backlog
+     * (auto-enable notices).
      *
      * Do not call enableNotices again before the previous callback fires —
      * concurrent enable calls are not specified.

package/src/modules/webrtc/qbRTCPeerConnection.js

@@ -542,92 +542,110 @@ function _getStats(peer, lastResults, successCallback, errorCallback) {
 
     peer.getStats(null).then(function (results) {
         results.forEach(function (result) {
-            var item;
-
-            if (result.bytesReceived && result.type === 'inbound-rtp') {
-                item = statistic.remote[result.mediaType];
-                item.bitrate = _getBitratePerSecond(result, lastResults, false);
-                item.bytesReceived = result.bytesReceived;
-                item.packetsReceived = result.packetsReceived;
-                item.timestamp = result.timestamp;
-                if (result.mediaType === 'video' && result.framerateMean) {
-                    item.framesPerSecond = Math.round(result.framerateMean * 10) / 10;
-                }
-            } else if (result.bytesSent && result.type === 'outbound-rtp') {
-                item = statistic.local[result.mediaType];
-                item.bitrate = _getBitratePerSecond(result, lastResults, true);
-                item.bytesSent = result.bytesSent;
-                item.packetsSent = result.packetsSent;
-                item.timestamp = result.timestamp;
-                if (result.mediaType === 'video' && result.framerateMean) {
-                    item.framesPerSecond = Math.round(result.framerateMean * 10) / 10;
-                }
-            } else if (result.type === 'local-candidate') {
-                item = statistic.local.candidate;
-                if (result.candidateType === 'host' && result.mozLocalTransport === 'udp' && result.transport === 'udp') {
-                    item.protocol = result.transport;
-                    item.ip = result.ipAddress;
-                    item.port = result.portNumber;
-                } else if (!Helpers.getVersionFirefox()) {
-                    item.protocol = result.protocol;
-                    item.ip = result.ip;
-                    item.port = result.port;
-                }
-            } else if (result.type === 'remote-candidate') {
-                item = statistic.remote.candidate;
-                item.protocol = result.protocol || result.transport;
-                item.ip = result.ip || result.ipAddress;
-                item.port = result.port || result.portNumber;
-            } else if (result.type === 'track' && result.kind === 'video' && !Helpers.getVersionFirefox()) {
-                if (result.remoteSource) {
-                    item = statistic.remote.video;
-                    item.frameHeight = result.frameHeight;
-                    item.frameWidth = result.frameWidth;
-                    item.framesPerSecond = _getFramesPerSecond(result, lastResults, false);
-                } else {
-                    item = statistic.local.video;
-                    item.frameHeight = result.frameHeight;
-                    item.frameWidth = result.frameWidth;
-                    item.framesPerSecond = _getFramesPerSecond(result, lastResults, true);
-                }
-            }
+            _applyStatReport(statistic, result, lastResults);
         });
         successCallback(statistic, results);
     }, errorCallback);
+}
 
-    function _getBitratePerSecond(result, lastResults, isLocal) {
-        var lastResult = lastResults && lastResults.get(result.id),
-            seconds = lastResult ? ((result.timestamp - lastResult.timestamp) / 1000) : 5,
-            kilo = 1024,
-            bit = 8,
-            bitrate;
-
-        if (!lastResult) {
-            bitrate = 0;
-        } else if (isLocal) {
-            bitrate = bit * (result.bytesSent - lastResult.bytesSent) / (kilo * seconds);
+function _applyStatReport(statistic, result, lastResults) {
+    var item;
+    // mediaType is deprecated in the W3C webrtc-stats spec and replaced by kind.
+    // Safari/WebKit omits mediaType on some reports and provides only kind, so we
+    // normalize once and use it for both the statistic lookup and the 'video' check.
+    var mediaType = result.mediaType || result.kind;
+
+    if (result.bytesReceived && result.type === 'inbound-rtp') {
+        item = statistic.remote[mediaType];
+
+        if (item) {
+            item.bitrate = _getBitratePerSecond(result, lastResults, false);
+            item.bytesReceived = result.bytesReceived;
+            item.packetsReceived = result.packetsReceived;
+            item.timestamp = result.timestamp;
+            if (mediaType === 'video' && result.framerateMean) {
+                item.framesPerSecond = Math.round(result.framerateMean * 10) / 10;
+            }
+        } else {
+            Helpers.traceWarning('_getStats: skipping inbound-rtp report with unknown mediaType/kind: ' + mediaType);
+        }
+    } else if (result.bytesSent && result.type === 'outbound-rtp') {
+        item = statistic.local[mediaType];
+
+        if (item) {
+            item.bitrate = _getBitratePerSecond(result, lastResults, true);
+            item.bytesSent = result.bytesSent;
+            item.packetsSent = result.packetsSent;
+            item.timestamp = result.timestamp;
+            if (mediaType === 'video' && result.framerateMean) {
+                item.framesPerSecond = Math.round(result.framerateMean * 10) / 10;
+            }
+        } else {
+            Helpers.traceWarning('_getStats: skipping outbound-rtp report with unknown mediaType/kind: ' + mediaType);
+        }
+    } else if (result.type === 'local-candidate') {
+        item = statistic.local.candidate;
+        if (result.candidateType === 'host' && result.mozLocalTransport === 'udp' && result.transport === 'udp') {
+            item.protocol = result.transport;
+            item.ip = result.ipAddress;
+            item.port = result.portNumber;
+        } else if (!Helpers.getVersionFirefox()) {
+            item.protocol = result.protocol;
+            item.ip = result.ip;
+            item.port = result.port;
+        }
+    } else if (result.type === 'remote-candidate') {
+        item = statistic.remote.candidate;
+        item.protocol = result.protocol || result.transport;
+        item.ip = result.ip || result.ipAddress;
+        item.port = result.port || result.portNumber;
+    } else if (result.type === 'track' && result.kind === 'video' && !Helpers.getVersionFirefox()) {
+        if (result.remoteSource) {
+            item = statistic.remote.video;
+            item.frameHeight = result.frameHeight;
+            item.frameWidth = result.frameWidth;
+            item.framesPerSecond = _getFramesPerSecond(result, lastResults, false);
         } else {
-            bitrate = bit * (result.bytesReceived - lastResult.bytesReceived) / (kilo * seconds);
+            item = statistic.local.video;
+            item.frameHeight = result.frameHeight;
+            item.frameWidth = result.frameWidth;
+            item.framesPerSecond = _getFramesPerSecond(result, lastResults, true);
         }
+    }
+}
 
-        return Math.round(bitrate);
+function _getBitratePerSecond(result, lastResults, isLocal) {
+    var lastResult = lastResults && lastResults.get(result.id),
+        seconds = lastResult ? ((result.timestamp - lastResult.timestamp) / 1000) : 5,
+        kilo = 1024,
+        bit = 8,
+        bitrate;
+
+    if (!lastResult) {
+        bitrate = 0;
+    } else if (isLocal) {
+        bitrate = bit * (result.bytesSent - lastResult.bytesSent) / (kilo * seconds);
+    } else {
+        bitrate = bit * (result.bytesReceived - lastResult.bytesReceived) / (kilo * seconds);
     }
 
-    function _getFramesPerSecond(result, lastResults, isLocal) {
-        var lastResult = lastResults && lastResults.get(result.id),
-            seconds = lastResult ? ((result.timestamp - lastResult.timestamp) / 1000) : 5,
-            framesPerSecond;
+    return Math.round(bitrate);
+}
 
-        if (!lastResult) {
-            framesPerSecond = 0;
-        } else if (isLocal) {
-            framesPerSecond = (result.framesSent - lastResult.framesSent) / seconds;
-        } else {
-            framesPerSecond = (result.framesReceived - lastResult.framesReceived) / seconds;
-        }
+function _getFramesPerSecond(result, lastResults, isLocal) {
+    var lastResult = lastResults && lastResults.get(result.id),
+        seconds = lastResult ? ((result.timestamp - lastResult.timestamp) / 1000) : 5,
+        framesPerSecond;
 
-        return Math.round(framesPerSecond * 10) / 10;
+    if (!lastResult) {
+        framesPerSecond = 0;
+    } else if (isLocal) {
+        framesPerSecond = (result.framesSent - lastResult.framesSent) / seconds;
+    } else {
+        framesPerSecond = (result.framesReceived - lastResult.framesReceived) / seconds;
     }
+
+    return Math.round(framesPerSecond * 10) / 10;
 }
 
 // Find the line in sdpLines[startLine...endLine - 1] that starts with |prefix|
@@ -814,4 +832,7 @@ function setMediaBitrate(sdp, media, bitrate) {
     return newLines.join('\n');
 }
 
+// PRIVATE - exposed for unit tests only, not part of the public SDK contract.
+qbRTCPeerConnection._applyStatReport = _applyStatReport;
+
 module.exports = qbRTCPeerConnection;

package/src/plugins/streamManagement.js

@@ -0,0 +1,235 @@
+'use strict';
+
+/**
+ * QuickBlox JavaScript SDK
+ * Chat Stream Management plugin
+ * doc: http://xmpp.org/extensions/xep-0198.html
+ *
+ * To enable this features add to config
+ * ```javascript
+ * streamManagement: {
+ -    enable: true
+ - }
+ * ```
+ *
+ * Uses listener by QB.chat.onSentMessageCallback
+ *
+ * ```javascript
+ * QB.chat.onSentMessageCallback = function (messageLost, messageSent) {
+ *     if (messageLost) {
+ *         console.error('sendErrorCallback', messageLost);
+ *     } else {
+ *         console.info('sendMessageSuccessCallback', messageSent);
+ *     }
+ * };
+ * ```
+ */
+
+/** JSHint inline rules */
+/* globals $build */
+
+var Utils = require('../qbUtils'),
+    chatUtils = require('../modules/chat/qbChatHelpers');
+
+function StreamManagement(options) {
+
+    this._NS = 'urn:xmpp:sm:3';
+
+    this._isStreamManagementEnabled = false;
+
+    // Counter of the incoming stanzas
+    this._clientProcessedStanzasCounter = null;
+
+    // The client send stanza counter.
+    this._clientSentStanzasCounter = null;
+
+    this._intervalId = null;
+    
+    this._timeInterval = Utils.getTimeIntervalForCallBackMessage();
+
+    this.sentMessageCallback = null;
+
+    if(Utils.getEnv().browser){
+        this._parser = new DOMParser();
+    }
+
+    // connection
+    this._c = null;
+
+    this._nodeBuilder = null;
+    // Original connection.send method
+    this._originalSend = null;
+
+    // In progress stanzas queue
+    this._stanzasQueue = [];
+}
+
+
+StreamManagement.prototype.enable = function (connection, client) {
+    var self = this,
+        stanza,
+        enableParams = {
+            xmlns: self._NS
+        };
+
+    if(!self._isStreamManagementEnabled){
+        self._c = connection;
+        self._originalSend = this._c.send;
+        self._c.send = this.send.bind(self);
+    }
+
+    if(Utils.getEnv().browser){
+        this._clientProcessedStanzasCounter = null;
+        this._clientSentStanzasCounter = null;
+        self._addEnableHandlers();
+        stanza = $build('enable', enableParams);
+    } else {
+        self._nodeBuilder =  client.Stanza;
+        self._addEnableHandlers();
+        stanza = chatUtils.createStanza(self._nodeBuilder, enableParams, 'enable');
+    }
+
+    self._c.send(stanza);
+};
+
+StreamManagement.prototype._timeoutCallback = function () {
+    var self = this,
+        now = Date.now(),
+        updatedStanzasQueue = [];
+
+    if(self._stanzasQueue.length){
+        for(var i = 0; i < self._stanzasQueue.length; i++){
+            if(self._stanzasQueue[i] && self._stanzasQueue[i].time < now){
+                self.sentMessageCallback(self._stanzasQueue[i].message);
+            } else {
+                updatedStanzasQueue.push(self._stanzasQueue[i]);
+            }
+        }
+
+        self._stanzasQueue = updatedStanzasQueue;
+    }
+};
+
+StreamManagement.prototype._addEnableHandlers = function () {
+    var self = this;
+
+    if (Utils.getEnv().browser) {
+        self._c.XAddTrackedHandler(_incomingStanzaHandler.bind(self));
+    } else {
+        self._c.on('stanza', _incomingStanzaHandler.bind(self));
+    }
+
+    function _incomingStanzaHandler (stanza){
+        /*
+        * Getting incoming stanza tagName
+        * */
+
+        var tagName = stanza.name || stanza.tagName || stanza.nodeTree.tagName;
+
+        if(tagName === 'enabled'){
+            self._isStreamManagementEnabled = true;
+
+            return true;
+        }
+
+        if (self._isStreamManagementEnabled && tagName === 'message') {
+            clearInterval(self._intervalId);
+            self._intervalId = setInterval(self._timeoutCallback.bind(self), self._timeInterval);
+
+            return true;
+        }
+
+        if(chatUtils.getAttr(stanza, 'xmlns') !== self._NS){
+            self._increaseReceivedStanzasCounter();
+        }
+
+        if(tagName === 'r'){
+            var params = {
+                    xmlns: self._NS,
+                    h: self._clientProcessedStanzasCounter
+                },
+                answerStanza = Utils.getEnv().browser ? $build('a', params) :
+                    chatUtils.createStanza(self._nodeBuilder, params, 'a');
+
+            self._originalSend.call(self._c, answerStanza);
+
+            return true;
+        }
+
+        if(tagName === 'a'){
+            var h = parseInt(chatUtils.getAttr(stanza, 'h'));
+
+            self._checkCounterOnIncomeStanza(h);
+        }
+
+        return true;
+    }
+};
+
+StreamManagement.prototype.send = function (stanza, message) {
+    var self = this,
+        stanzaXML = stanza.nodeTree ? this._parser.parseFromString(stanza.nodeTree.outerHTML, "application/xml").childNodes[0] : stanza,
+        tagName = stanzaXML.name || stanzaXML.tagName || stanzaXML.nodeTree.tagName,
+        type = chatUtils.getAttr(stanzaXML, 'type'),
+        bodyContent = chatUtils.getElementText(stanzaXML, 'body') || '',
+        attachments = chatUtils.getAllElements(stanzaXML, 'attachment') || '';
+
+    try {
+        self._originalSend.call(self._c, stanza);
+    } catch (e) {
+        Utils.QBLog('[QBChat]', e.message);
+    } finally {
+        if (tagName === 'message' && (type === 'chat' || type === 'groupchat') && (bodyContent || attachments.length)) {
+            self._sendStanzasRequest({
+                message: message,
+                time: Date.now() + self._timeInterval,
+                expect: self._clientSentStanzasCounter
+            });
+        }
+    
+        self._clientSentStanzasCounter++;
+    }
+
+};
+
+StreamManagement.prototype._sendStanzasRequest = function (data) {
+    var self = this;
+
+    if(self._isStreamManagementEnabled){
+        self._stanzasQueue.push(data);
+
+        var stanza = Utils.getEnv().browser ? $build('r', { xmlns: self._NS }) :
+            chatUtils.createStanza(self._nodeBuilder, { xmlns: self._NS }, 'r');
+
+        if (self._c.connected) {
+            self._originalSend.call(self._c, stanza);
+        } else {
+            self._checkCounterOnIncomeStanza();
+        }
+    }
+};
+
+StreamManagement.prototype.getClientSentStanzasCounter = function(){
+    return this._clientSentStanzasCounter;
+};
+
+StreamManagement.prototype._checkCounterOnIncomeStanza = function (count){
+    var updatedStanzasQueue = [];
+
+    if(this._stanzasQueue.length){
+        for(var i = 0; i < this._stanzasQueue.length; i++){
+            if(this._stanzasQueue[i].expect == count){
+                this.sentMessageCallback(null, this._stanzasQueue[i].message);
+            } else {
+                updatedStanzasQueue.push(this._stanzasQueue[i]);
+            }
+        }
+        this._stanzasQueue = updatedStanzasQueue;
+    }
+};
+
+StreamManagement.prototype._increaseReceivedStanzasCounter = function(){
+    this._clientProcessedStanzasCounter++;
+};
+
+module.exports = StreamManagement;

package/src/qbConfig.js

@@ -12,8 +12,8 @@
  */
 
 var config = {
-  version: '2.24.0-beta.1',
-  buildNumber: '1179',
+  version: '2.24.0',
+  buildNumber: '1180',
   creds: {
     'appId': 0,
     'authKey': '',