feat: Adds option to set ws keepalive url through config.

doc/API.md

@@ -232,6 +232,9 @@ This objects represents the server connection. You can create new `JitsiConnecti
             - `interval` - how often to send ping requests, default: 10000 (10 seconds)
             - `timeout` - the time to wait for ping responses, default: 5000 (5 seconds)
             - `threshold` - how many ping failures will be tolerated before the connection is killed, default: 2
+        7. websocketKeepAlive - (optional) Setting the interval of websocket keepalive GET requests. By default, the value is 1 minute(which means a minute + a minute of jitter).
+           Used for certain deployments where a stick table entry needs to be kept alive we use those GET requests.
+        8. websocketKeepAliveUrl - (optional) Specific Url to use for the websocket keepalive GET requests.
 
 2. `connect(options)` - establish server connection
     - `options` - JS Object with `id` and `password` properties.

modules/xmpp/XmppConnection.js

@@ -46,16 +46,19 @@ export default class XmppConnection extends Listenable {
      * It will enable automatically by default if supported by the XMPP server.
      * @param {Number} [options.websocketKeepAlive=60000] - The websocket keep alive interval.
      * It's the interval + a up to a minute of jitter. Pass -1 to disable.
-     * The keep alive is HTTP GET request to the {@link options.serviceUrl}.
+     * The keep alive is HTTP GET request to {@link options.serviceUrl} or to {@link options.websocketKeepAliveUrl}.
+     * @param {Number} [options.websocketKeepAliveUrl] - The websocket keep alive url to use if any,
+     * if missing the serviceUrl url will be used.
      * @param {Object} [options.xmppPing] - The xmpp ping settings.
      */
-    constructor({ enableWebsocketResume, websocketKeepAlive, serviceUrl, shard, xmppPing }) {
+    constructor({ enableWebsocketResume, websocketKeepAlive, websocketKeepAliveUrl, serviceUrl, shard, xmppPing }) {
         super();
         this._options = {
             enableWebsocketResume: typeof enableWebsocketResume === 'undefined' ? true : enableWebsocketResume,
             pingOptions: xmppPing,
             shard,
-            websocketKeepAlive: typeof websocketKeepAlive === 'undefined' ? 60 * 1000 : Number(websocketKeepAlive)
+            websocketKeepAlive: typeof websocketKeepAlive === 'undefined' ? 60 * 1000 : Number(websocketKeepAlive),
+            websocketKeepAliveUrl
         };
 
         this._stropheConn = new Strophe.Connection(serviceUrl);
@@ -404,8 +407,9 @@ export default class XmppConnection extends Listenable {
      * @returns {Promise}
      */
     _keepAliveAndCheckShard() {
-        const { shard } = this._options;
-        const url = this.service.replace('wss://', 'https://').replace('ws://', 'http://');
+        const { shard, websocketKeepAliveUrl } = this._options;
+        const url = websocketKeepAliveUrl ? websocketKeepAliveUrl
+            : this.service.replace('wss://', 'https://').replace('ws://', 'http://');
 
         return fetch(url)
             .then(response => {

modules/xmpp/xmpp.js

@@ -33,6 +33,7 @@ const logger = getLogger(__filename);
  * @param {string} options.shard - The shard where XMPP connection initially landed.
  * @param {string} options.enableWebsocketResume - True to enable stream resumption.
  * @param {number} [options.websocketKeepAlive] - See {@link XmppConnection} constructor.
+ * @param {number} [options.websocketKeepAliveUrl] - See {@link XmppConnection} constructor.
  * @param {Object} [options.xmppPing] - See {@link XmppConnection} constructor.
  * @returns {XmppConnection}
  */
@@ -42,6 +43,7 @@ function createConnection({
     shard,
     token,
     websocketKeepAlive,
+    websocketKeepAliveUrl,
     xmppPing }) {
 
     // Append token as URL param
@@ -54,6 +56,7 @@ function createConnection({
         enableWebsocketResume,
         serviceUrl,
         websocketKeepAlive,
+        websocketKeepAliveUrl,
         xmppPing,
         shard
     });
@@ -113,6 +116,8 @@ export default class XMPP extends Listenable {
      * module try to resume the session in case the Websocket connection breaks.
      * @param {number} [options.websocketKeepAlive] - The websocket keep alive interval. See {@link XmppConnection}
      * constructor for more details.
+     * @param {number} [options.websocketKeepAliveUrl] - The websocket keep alive url. See {@link XmppConnection}
+     * constructor for more details.
      * @param {Object} [options.xmppPing] - The xmpp ping settings.
      * @param {Array<Object>} options.p2pStunServers see {@link JingleConnectionPlugin} for more details.
      * @param token
@@ -140,6 +145,7 @@ export default class XMPP extends Listenable {
             serviceUrl: options.serviceUrl || options.bosh,
             token,
             websocketKeepAlive: options.websocketKeepAlive,
+            websocketKeepAliveUrl: options.websocketKeepAliveUrl,
             xmppPing,
             shard: options.deploymentInfo?.shard
         });