feat(JitsiConference) add ability to set the leave reason

Co-authored-by: Дамян Минков <damencho@jitsi.org>

JitsiConference.js

@@ -627,9 +627,10 @@ JitsiConference.prototype.isP2PTestModeEnabled = function() {
 
 /**
  * Leaves the conference.
+ * @param reason {string|undefined} The reason for leaving the conference.
  * @returns {Promise}
  */
-JitsiConference.prototype.leave = async function() {
+JitsiConference.prototype.leave = async function(reason) {
     if (this.participantConnectionStatus) {
         this.participantConnectionStatus.dispose();
         this.participantConnectionStatus = null;
@@ -710,7 +711,7 @@ JitsiConference.prototype.leave = async function() {
     let leaveError;
 
     try {
-        await room.leave();
+        await room.leave(reason);
     } catch (err) {
         leaveError = err;
 
@@ -1946,7 +1947,7 @@ JitsiConference.prototype._onMemberBotTypeChanged = function(jid, botType) {
     }
 };
 
-JitsiConference.prototype.onMemberLeft = function(jid) {
+JitsiConference.prototype.onMemberLeft = function(jid, reason) {
     const id = Strophe.getResourceFromJid(jid);
 
     if (id === 'focus' || this.myUserId() === id) {
@@ -1973,7 +1974,7 @@ JitsiConference.prototype.onMemberLeft = function(jid) {
 
     if (participant) {
         delete this.participants[id];
-        this.eventEmitter.emit(JitsiConferenceEvents.USER_LEFT, id, participant);
+        this.eventEmitter.emit(JitsiConferenceEvents.USER_LEFT, id, participant, reason);
     }
 
     if (this.room !== null) { // Skip if we have left the room already.

modules/xmpp/ChatRoom.js

@@ -259,10 +259,16 @@ export default class ChatRoom extends Listenable {
      * Sends the presence unavailable, signaling the server
      * we want to leave the room.
      */
-    doLeave() {
+    doLeave(reason) {
         logger.log('do leave', this.myroomjid);
-        const pres = $pres({ to: this.myroomjid,
-            type: 'unavailable' });
+        const pres = $pres({
+            to: this.myroomjid,
+            type: 'unavailable'
+        });
+
+        if (reason) {
+            pres.c('status').t(reason).up();
+        }
 
         this.presMap.length = 0;
 
@@ -937,15 +943,16 @@ export default class ChatRoom extends Listenable {
      * @param jid the jid of the participant that leaves
      * @param skipEvents optional params to skip any events, including check
      * whether this is the focus that left
+     * @param reason the reason for leaving (optional).
      */
-    onParticipantLeft(jid, skipEvents) {
+    onParticipantLeft(jid, skipEvents, reason) {
         delete this.lastPresences[jid];
 
         if (skipEvents) {
             return;
         }
 
-        this.eventEmitter.emit(XMPPEvents.MUC_MEMBER_LEFT, jid);
+        this.eventEmitter.emit(XMPPEvents.MUC_MEMBER_LEFT, jid, reason);
 
         this.moderator.onMucMemberLeft(jid);
     }
@@ -1047,8 +1054,15 @@ export default class ChatRoom extends Listenable {
                 this.eventEmitter.emit(XMPPEvents.MUC_LEFT);
             }
         } else {
+            const reasonSelect = $(pres).find('>status');
+            let reason;
+
+            if (reasonSelect.length) {
+                reason = reasonSelect.text();
+            }
+
             delete this.members[from];
-            this.onParticipantLeft(from, false);
+            this.onParticipantLeft(from, false, reason);
         }
     }
 
@@ -1829,7 +1843,7 @@ export default class ChatRoom extends Listenable {
      * less than 5s after sending presence unavailable. Otherwise the promise is
      * rejected.
      */
-    leave() {
+    leave(reason) {
         this.avModeration.dispose();
         this.breakoutRooms.dispose();
 
@@ -1856,7 +1870,7 @@ export default class ChatRoom extends Listenable {
 
             this.clean();
             this.eventEmitter.on(XMPPEvents.MUC_LEFT, onMucLeft);
-            this.doLeave();
+            this.doLeave(reason);
         }));
 
         return Promise.allSettled(promises);

types/auto/JitsiConference.d.ts

@@ -252,9 +252,10 @@ declare class JitsiConference {
     isP2PTestModeEnabled(): boolean;
     /**
      * Leaves the conference.
+     * @param reason {string|undefined} The reason for leaving the conference.
      * @returns {Promise}
      */
-    leave(): Promise<any>;
+    leave(reason: string | undefined): Promise<any>;
     /**
      * Returns the currently active media session if any.
      *
@@ -622,7 +623,7 @@ declare class JitsiConference {
     private _onMucJoined;
     private _updateFeatures;
     private _onMemberBotTypeChanged;
-    onMemberLeft(jid: any): void;
+    onMemberLeft(jid: any, reason: any): void;
     /**
      * Designates an event indicating that we were kicked from the XMPP MUC.
      * @param {boolean} isSelfPresence - whether it is for local participant

types/auto/modules/xmpp/ChatRoom.d.ts

@@ -80,7 +80,7 @@ export default class ChatRoom extends Listenable {
      * Sends the presence unavailable, signaling the server
      * we want to leave the room.
      */
-    doLeave(): void;
+    doLeave(reason: any): void;
     /**
      *
      */
@@ -163,8 +163,9 @@ export default class ChatRoom extends Listenable {
      * @param jid the jid of the participant that leaves
      * @param skipEvents optional params to skip any events, including check
      * whether this is the focus that left
+     * @param reason the reason for leaving (optional).
      */
-    onParticipantLeft(jid: any, skipEvents: any): void;
+    onParticipantLeft(jid: any, skipEvents: any, reason: any): void;
     /**
      *
      * @param pres
@@ -367,7 +368,7 @@ export default class ChatRoom extends Listenable {
      * less than 5s after sending presence unavailable. Otherwise the promise is
      * rejected.
      */
-    leave(): Promise<any>;
+    leave(reason: any): Promise<any>;
 }
 import Listenable from "../util/Listenable";
 import XmppConnection from "./XmppConnection";