close if facilitator doesn't join within 3 minutes

This commit is contained in:
Sharon Kennedy 2020-09-05 18:11:06 -04:00
parent 1e3b63fe5b
commit 6d4b6b1609
3 changed files with 167 additions and 101 deletions

100
dist/bot.js vendored
View File

@ -26,6 +26,7 @@ var _logger = _interopRequireDefault(require("./logger"));
var _encryptAttachment = _interopRequireDefault(require("./encrypt-attachment")); var _encryptAttachment = _interopRequireDefault(require("./encrypt-attachment"));
global.Olm = require("olm"); global.Olm = require("olm");
const BOT_SIGNAL_END_CHAT = 'END_CHAT';
class OcrccBot { class OcrccBot {
constructor(botConfig) { constructor(botConfig) {
@ -227,35 +228,43 @@ class OcrccBot {
} }
handleBotCommand(event) { handleBotCommand(event) {
const botCommands = [{
keyword: 'transcript',
function: (senderId, roomId) => {
this.sendTranscript(senderId, roomId);
}
}, {
keyword: 'delete transcript',
function: (senderId, roomId) => {
this.deleteTranscript(senderId, roomId);
}
}, {
keyword: 'say',
function: (senderId, roomId, message) => {
this.sendTextMessage(roomId, message, senderId);
}
}, {
keyword: 'hi',
function: (senderId, roomId) => {
const responses = ["Hi!", "Hello", "Hey :)", "Hi there", "Bleep bloop"];
const message = responses[Math.floor(Math.random() * responses.length)];
this.sendTextMessage(roomId, message, senderId);
}
}];
try { try {
const senderId = event.getSender(); const senderId = event.getSender();
const roomId = event.getRoomId(); const roomId = event.getRoomId();
const content = event.getContent(); const content = event.getContent();
const command = content.body.substring("!bot".length).trim(); const commandText = content.body.substring("!bot".length).trim();
const command = botCommands.find(c => commandText.startsWith(c.keyword));
switch (command) { if (!command) {
case "transcript":
this.sendTranscript(senderId, roomId);
break;
case "transcript please":
this.sendTranscript(senderId, roomId);
break;
case "delete transcript":
this.deleteTranscript(senderId, roomId);
break;
case "hi":
const responses = ["Hi!", "Hello", "Hey :)", "Hi there", "Bleep bloop"];
const message = responses[Math.floor(Math.random() * responses.length)];
this.sendTextMessage(roomId, message, senderId);
break;
default:
this.sendTextMessage(roomId, `Sorry, I don't know that command. I'm not a very smart bot.`, senderId); this.sendTextMessage(roomId, `Sorry, I don't know that command. I'm not a very smart bot.`, senderId);
break;
} }
const args = commandText.substring(command.keyword.length).trim();
command.function(senderId, roomId, args);
} catch (err) { } catch (err) {
_logger.default.log("error", `ERROR EXECUTING BOT COMMAND: ${err}`); _logger.default.log("error", `ERROR EXECUTING BOT COMMAND: ${err}`);
} }
@ -418,9 +427,9 @@ class OcrccBot {
_logger.default.log("info", "AUTO JOINED ROOM => " + room.roomId); _logger.default.log("info", "AUTO JOINED ROOM => " + room.roomId);
const currentDate = new Date(); const inviteDate = event.getDate();
const chatDate = currentDate.toLocaleDateString(); const chatDate = inviteDate.toLocaleDateString();
const chatTime = currentDate.toLocaleTimeString(); const chatTime = inviteDate.toLocaleTimeString();
const roomId = room.roomId.split(':')[0]; const roomId = room.roomId.split(':')[0];
const notification = `Incoming support chat at ${chatTime} (room ID: ${roomId})`; const notification = `Incoming support chat at ${chatTime} (room ID: ${roomId})`;
this.sendTextMessage(this.config.FACILITATOR_ROOM_ID, notification); this.sendTextMessage(this.config.FACILITATOR_ROOM_ID, notification);
@ -489,8 +498,16 @@ class OcrccBot {
const joinedRooms = roomData["joined_rooms"]; const joinedRooms = roomData["joined_rooms"];
const isBotInRoom = joinedRooms.includes(member.roomId); const isBotInRoom = joinedRooms.includes(member.roomId);
const room = this.client.getRoom(member.roomId); const room = this.client.getRoom(member.roomId);
if (!room) return; // leave if there is nobody in the room if (!room) return; // notify room if the facilitator has left
const facilitatorId = this.localStorage.getItem(`${member.roomId}-facilitator`);
if (isBotInRoom && member.userId === facilitatorId) {
this.sendTextMessage(member.roomId, `${member.name} has left the chat.`);
} // leave if there is nobody in the room
try {
const memberCount = room.getJoinedMemberCount(); const memberCount = room.getJoinedMemberCount();
if (memberCount === 1 && isBotInRoom) { if (memberCount === 1 && isBotInRoom) {
@ -501,13 +518,28 @@ class OcrccBot {
this.localStorage.removeItem(`${member.roomId}-facilitator`); this.localStorage.removeItem(`${member.roomId}-facilitator`);
this.localStorage.removeItem(`${member.roomId}-transcript`); this.localStorage.removeItem(`${member.roomId}-transcript`);
return this.client.leave(member.roomId); return this.client.leave(member.roomId);
} // notify room if the facilitator has left }
} catch (err) {
_logger.default.log("error", `ERROR LEAVING EMPTY ROOM ==> ${err}`);
} // send signal to close the chat if there are no facilitators in the room
const facilitatorId = this.localStorage.getItem(`${member.roomId}-facilitator`); try {
const roomMembers = await room.getJoinedMembers();
const facilitatorRoomMembers = await this.client.getJoinedRoomMembers(this.config.FACILITATOR_ROOM_ID);
const facilitators = facilitatorRoomMembers['joined'];
let facilitatorInRoom = false;
roomMembers.forEach(member => {
if (member.userId !== this.config.BOT_USERID && Boolean(facilitators[member.userId])) {
facilitatorInRoom = true;
}
});
if (isBotInRoom && member.userId === facilitatorId) { if (!facilitatorInRoom) {
this.sendTextMessage(member.roomId, `${member.name} has left the chat.`); this.sendBotSignal(member.roomId, BOT_SIGNAL_END_CHAT);
}
} catch (err) {
_logger.default.log("error", `ERROR SENDING BOT SIGNAL ==> ${err}`);
} }
} }
}); });
@ -543,6 +575,14 @@ class OcrccBot {
}); });
} }
async sendBotSignal(roomId, signal, args) {
let content = {
signal: signal,
args: args
};
await this.client.sendStateEvent(roomId, 'm.bot.signal', content);
}
async start() { async start() {
const localStorage = this.createLocalStorage(); const localStorage = this.createLocalStorage();
this.localStorage = localStorage; this.localStorage = localStorage;

View File

@ -443,6 +443,7 @@ class OcrccBot {
const notification = `Incoming support chat at ${chatTime} (room ID: ${roomId})` const notification = `Incoming support chat at ${chatTime} (room ID: ${roomId})`
this.sendTextMessage(this.config.FACILITATOR_ROOM_ID, notification); this.sendTextMessage(this.config.FACILITATOR_ROOM_ID, notification);
this.inviteFacilitators(room.roomId) this.inviteFacilitators(room.roomId)
this.setTimeoutforFacilitators(room.roomId)
} }
} catch(err) { } catch(err) {
logger.log("error", "ERROR JOINING ROOM => " + err) logger.log("error", "ERROR JOINING ROOM => " + err)
@ -454,6 +455,7 @@ class OcrccBot {
member.userId !== this.config.BOT_USERID && member.userId !== this.config.BOT_USERID &&
this.localStorage.getItem(`${member.roomId}-waiting`) this.localStorage.getItem(`${member.roomId}-waiting`)
) { ) {
try {
// make sure it's a facilitator joining // make sure it's a facilitator joining
const roomMembers = await this.client.getJoinedRoomMembers(this.config.FACILITATOR_ROOM_ID) const roomMembers = await this.client.getJoinedRoomMembers(this.config.FACILITATOR_ROOM_ID)
const members = Object.keys(roomMembers["joined"]); const members = Object.keys(roomMembers["joined"]);
@ -510,6 +512,9 @@ class OcrccBot {
this.localStorage.setItem(`${member.roomId}-transcript`, filepath) this.localStorage.setItem(`${member.roomId}-transcript`, filepath)
} }
} }
} catch(err) {
logger.log("error", `ERROR WHEN FACILITATOR JOINED ROOM ==> ${err}`);
}
} }
if ( if (
@ -524,6 +529,7 @@ class OcrccBot {
const room = this.client.getRoom(member.roomId) const room = this.client.getRoom(member.roomId)
if (!room) return; if (!room) return;
try {
// notify room if the facilitator has left // notify room if the facilitator has left
const facilitatorId = this.localStorage.getItem(`${member.roomId}-facilitator`) const facilitatorId = this.localStorage.getItem(`${member.roomId}-facilitator`)
if (isBotInRoom && member.userId === facilitatorId) { if (isBotInRoom && member.userId === facilitatorId) {
@ -532,6 +538,9 @@ class OcrccBot {
`${member.name} has left the chat.` `${member.name} has left the chat.`
); );
} }
} catch(err) {
logger.log("error", `ERROR NOTIFYING THAT FACLITATOR HAS LEFT THE ROOM ==> ${err}`);
}
// leave if there is nobody in the room // leave if there is nobody in the room
try { try {
@ -571,6 +580,15 @@ class OcrccBot {
}) })
} }
setTimeoutforFacilitators(roomId) {
setTimeout(() => {
const stillWaiting = this.localStorage.getItem(`${roomId}-waiting`)
if (stillWaiting) {
this.sendBotSignal(roomId, BOT_SIGNAL_END_CHAT)
}
}, this.config.MAX_WAIT_TIME)
}
async setMessageListeners() { async setMessageListeners() {
// encrypted messages // encrypted messages
this.client.on("Event.decrypted", (event, err) => { this.client.on("Event.decrypted", (event, err) => {
@ -606,8 +624,11 @@ class OcrccBot {
signal: signal, signal: signal,
args: args, args: args,
} }
try {
await this.client.sendStateEvent(roomId, 'm.bot.signal', content) await this.client.sendStateEvent(roomId, 'm.bot.signal', content)
} catch(err) {
logger.log('error', "ERROR SENDING BOT SIGNAL => " + err)
}
} }
async start() { async start() {

View File

@ -5,6 +5,7 @@ const KICK_REASON = "A facilitator has already joined this chat.";
const BOT_ERROR_MESSAGE = const BOT_ERROR_MESSAGE =
"Something went wrong on our end, please restart the chat and try again."; "Something went wrong on our end, please restart the chat and try again.";
const MAX_RETRIES = 3; const MAX_RETRIES = 3;
const { const {
MATRIX_SERVER_URL, MATRIX_SERVER_URL,
BOT_USERNAME, BOT_USERNAME,
@ -13,6 +14,8 @@ const {
BOT_DISPLAY_NAME, BOT_DISPLAY_NAME,
FACILITATOR_ROOM_ID, FACILITATOR_ROOM_ID,
CAPTURE_TRANSCRIPTS, CAPTURE_TRANSCRIPTS,
CHAT_NOT_AVAILABLE_MESSAGE,
MAX_WAIT_TIME,
} = process.env; } = process.env;
const botConfig = { const botConfig = {
@ -27,6 +30,8 @@ const botConfig = {
BOT_DISPLAY_NAME, BOT_DISPLAY_NAME,
FACILITATOR_ROOM_ID, FACILITATOR_ROOM_ID,
CAPTURE_TRANSCRIPTS, CAPTURE_TRANSCRIPTS,
CHAT_NOT_AVAILABLE_MESSAGE,
MAX_WAIT_TIME,
} }
import OcrccBot from './bot' import OcrccBot from './bot'