feat: Polls using component. (#2916)

* squash: Moves to use component.

* squash: Uses json-message format with types.

* squash: Fixes comments and moves validate polls to backend.

* squash: Drops roomJid from messages.

Author: damencho

JitsiConference.ts

@@ -54,6 +54,7 @@ import type { ChatRoom, PresenceHandler } from './modules/xmpp/ChatRoom';
 import FileSharing from './modules/xmpp/FileSharing';
 import type JingleSessionPC from './modules/xmpp/JingleSessionPC';
 import { MediaSessionEvents } from './modules/xmpp/MediaSessionEvents';
+import Polls from './modules/xmpp/Polls';
 import RoomMetadata from './modules/xmpp/RoomMetadata';
 import SignalingLayerImpl from './modules/xmpp/SignalingLayerImpl';
 import XMPP, {
@@ -4634,6 +4635,15 @@ export default class JitsiConference extends Listenable {
         return this.room?.getMetadataHandler();
     }
 
+    /**
+     * Returns the polls object.
+     *
+     * @returns {Optional<Polls>} the polls.
+     */
+    public getPolls(): Optional<Polls> {
+        return this.room?.getPolls();
+    }
+
     /**
      * Requests short-term credentials from the backend if available.
      * @param {string} service - The service for which to request the credentials.

JitsiConferenceEventManager.ts

@@ -391,6 +391,11 @@ export default class JitsiConferenceEventManager {
                     participantId, txt, ts, displayName, isVisitor, messageId, source, replyToId);
             });
 
+        this.chatRoomForwarder.forward(XMPPEvents.POLLS_RECEIVE_EVENT,
+            JitsiConferenceEvents.POLL_RECEIVED);
+        this.chatRoomForwarder.forward(XMPPEvents.POLLS_ANSWER_EVENT,
+            JitsiConferenceEvents.POLL_ANSWER_RECEIVED);
+
         chatRoom.addListener(
             XMPPEvents.REACTION_RECEIVED,
 

JitsiConferenceEvents.ts

@@ -338,6 +338,16 @@ export enum JitsiConferenceEvents {
      */
     PHONE_NUMBER_CHANGED = 'conference.phoneNumberChanged',
 
+    /**
+     * An answer for a pool was received.
+     */
+    POLL_ANSWER_RECEIVED = 'conference.pollAnswerReceived',
+
+    /**
+     * A new poll was received or a poll is loaded from the history.
+     */
+    POLL_RECEIVED = 'conference.pollReceived',
+
     /**
      * New private text message was received.
      */

modules/xmpp/ChatRoom.ts

@@ -20,6 +20,7 @@ import AVModeration from './AVModeration';
 import BreakoutRooms from './BreakoutRooms';
 import FileSharing from './FileSharing';
 import Lobby from './Lobby';
+import Polls from './Polls';
 import RoomMetadata from './RoomMetadata';
 import XmppConnection, { ErrorCallback } from './XmppConnection';
 import XMPP, { FEATURE_TRANSCRIBER } from './xmpp';
@@ -232,6 +233,7 @@ export default class ChatRoom extends Listenable {
     private avModeration: AVModeration;
     private breakoutRooms: BreakoutRooms;
     private fileSharing: FileSharing;
+    private polls: Polls;
     private roomMetadata: RoomMetadata;
     private lastPresences: Record<string, IPresenceNode[]>;
     private phoneNumber: Nullable<string>;
@@ -308,6 +310,7 @@ export default class ChatRoom extends Listenable {
         this.avModeration = new AVModeration(this);
         this.breakoutRooms = new BreakoutRooms(this);
         this.fileSharing = new FileSharing(this);
+        this.polls = new Polls(this);
         this.roomMetadata = new RoomMetadata(this);
         this.initPresenceMap(options);
         this.lastPresences = {};
@@ -2048,6 +2051,13 @@ export default class ChatRoom extends Listenable {
         return this.roomMetadata;
     }
 
+    /**
+     * @returns {Polls}
+     */
+    public getPolls(): Polls {
+        return this.polls;
+    }
+
     /**
      * Returns the phone number for joining the conference.
      */
@@ -2186,6 +2196,7 @@ export default class ChatRoom extends Listenable {
         this.avModeration.dispose();
         this.breakoutRooms.dispose();
         this.fileSharing.dispose();
+        this.polls.dispose();
         this.roomMetadata.dispose();
 
         const promises = [];

modules/xmpp/FileSharing.ts

@@ -85,9 +85,9 @@ export default class FileSharing {
     }
 
     /**
-     * Whether AV moderation is supported on backend.
+     * Whether file sharing is supported on backend.
      *
-     * @returns {boolean} whether AV moderation is supported on backend.
+     * @returns {boolean} whether file sharing is supported on backend.
      */
     isSupported() {
         return Boolean(this._xmpp.fileSharingComponentAddress);

modules/xmpp/Polls.ts

@@ -0,0 +1,109 @@
+import { XMPPEvents } from '../../service/xmpp/XMPPEvents';
+
+import ChatRoom from './ChatRoom';
+import XMPP from './xmpp';
+
+export const COMMAND_ANSWER_POLL = 'answer-poll';
+export const COMMAND_NEW_POLL = 'new-poll';
+export const COMMAND_OLD_POLLS = 'old-polls';
+
+export default class Polls {
+    private _mainRoom: ChatRoom;
+    private _xmpp: XMPP;
+
+    /**
+     * Constructs polls for a room.
+     *
+     * @param {ChatRoom} room the main room.
+     */
+    constructor(room: ChatRoom) {
+        this._mainRoom = room;
+        this._xmpp = room.xmpp;
+
+        this._handleMessages = this._handleMessages.bind(this);
+        this._mainRoom.xmpp.addListener(XMPPEvents.POLLS_EVENT, this._handleMessages);
+    }
+
+    /**
+     * Whether polls is supported on backend.
+     *
+     * @returns {boolean} whether polls is supported on backend.
+     */
+    isSupported() {
+        return Boolean(this._xmpp.pollsComponentAddress);
+    }
+
+    /**
+     * Stops listening for events.
+     */
+    dispose() {
+        this._mainRoom.xmpp.removeListener(XMPPEvents.POLLS_EVENT, this._handleMessages);
+    }
+
+    /**
+     * Creates and sends a new poll.
+     *
+     * @param pollId
+     * @param question
+     * @param answers
+     */
+    createPoll(pollId: string, question: string, answers: Array<{ name: string; }>) {
+        this._mainRoom.sendPrivateMessage(
+            this._xmpp.pollsComponentAddress,
+            JSON.stringify({
+                answers: answers,
+                command: COMMAND_NEW_POLL,
+                pollId,
+                question,
+                type: 'polls'
+            }),
+            'json-message',
+            true);
+    }
+
+    /**
+     * Sends answers for a poll.
+     *
+     * @param pollId
+     * @param answers
+     */
+    answerPoll(pollId: string, answers: Array<boolean>) {
+        this._mainRoom.sendPrivateMessage(
+            this._xmpp.pollsComponentAddress,
+            JSON.stringify({
+                answers,
+                command: COMMAND_ANSWER_POLL,
+                pollId,
+                type: 'polls'
+            }),
+            'json-message',
+            true);
+    }
+
+    /**
+     * Handles a message for polls.
+     *
+     * @param {object} payload - Arbitrary data.
+     */
+    _handleMessages(payload) {
+        switch (payload.command) {
+        case COMMAND_NEW_POLL:
+            this._mainRoom.eventEmitter.emit(XMPPEvents.POLLS_RECEIVE_EVENT, payload);
+
+            break;
+        case COMMAND_OLD_POLLS: {
+            payload?.polls?.forEach((poll: any) => {
+                this._mainRoom.eventEmitter.emit(XMPPEvents.POLLS_RECEIVE_EVENT, {
+                    history: true,
+                    ...poll
+                });
+            });
+            break;
+        }
+        case COMMAND_ANSWER_POLL: {
+            this._mainRoom.eventEmitter.emit(XMPPEvents.POLLS_ANSWER_EVENT, payload);
+            break;
+        }
+        }
+    }
+}

modules/xmpp/xmpp.ts

@@ -279,6 +279,7 @@ export default class XMPP extends Listenable {
     public breakoutRoomsFeatures: Optional<IBreakoutRoomsFeatures>;
     public fileSharingComponentAddress: Optional<string>;
     public roomMetadataComponentAddress: Optional<string>;
+    public pollsComponentAddress: Optional<string>;
 
 
     /**
@@ -496,6 +497,8 @@ export default class XMPP extends Listenable {
             this.eventEmitter.emit(XMPPEvents.ROOM_METADATA_EVENT, parsedJson);
         } else if (parsedJson[JITSI_MEET_MUC_TYPE] === 'visitors') {
             this.eventEmitter.emit(XMPPEvents.VISITORS_MESSAGE, parsedJson);
+        } else if (parsedJson[JITSI_MEET_MUC_TYPE] === 'polls') {
+            this.eventEmitter.emit(XMPPEvents.POLLS_EVENT, parsedJson);
         }
 
         return true;
@@ -648,6 +651,11 @@ export default class XMPP extends Listenable {
             if (identity.type === 'visitors') {
                 this._components.push(identity.name);
             }
+
+            if (identity.type === 'polls') {
+                this.pollsComponentAddress = identity.name;
+                this._components.push(this.pollsComponentAddress);
+            }
         });
 
         this._maybeSendDeploymentInfoStat(true);

service/xmpp/XMPPEvents.ts

@@ -276,6 +276,22 @@ export enum XMPPEvents {
      * Indicates that phone number changed.
      */
     PHONE_NUMBER_CHANGED = 'conference.phoneNumberChanged',
+
+    /**
+     * Event fired when we receive an answer for a poll.
+     */
+    POLLS_ANSWER_EVENT = 'xmpp.polls.answer.event',
+
+    /**
+     * Event fired when we receive a message for polls.
+     */
+    POLLS_EVENT = 'xmpp.polls.event',
+
+    /**
+     * Event fired when we received a poll or polls history event (old-polls).
+     */
+    POLLS_RECEIVE_EVENT = 'xmpp.polls.received.event',
+
     PRESENCE_RECEIVED = 'xmpp.presence_received',
     PRESENCE_STATUS = 'xmpp.presence_status',