Compare commits
11 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
4fdddc8c92 | ||
|
|
d53a5c5e26 | ||
|
|
9772b3b1fd | ||
|
|
84fe91adbb | ||
|
|
b6cd85eab0 | ||
|
|
209b3aaa45 | ||
|
|
4912ce6f61 | ||
|
|
013ffa318f | ||
|
|
ac2f953b90 | ||
|
|
a25c71a04a | ||
|
|
836d4751ad |
@@ -1,5 +1,7 @@
|
|||||||
FROM node:10-alpine
|
FROM node:10-alpine
|
||||||
|
|
||||||
|
RUN apk add g++ make python
|
||||||
|
|
||||||
RUN mkdir -p /home/node/app/node_modules && chown -R node:node /home/node/app
|
RUN mkdir -p /home/node/app/node_modules && chown -R node:node /home/node/app
|
||||||
|
|
||||||
WORKDIR /home/node/app
|
WORKDIR /home/node/app
|
||||||
|
|||||||
150
dist/bot.js
vendored
150
dist/bot.js
vendored
@@ -33,6 +33,7 @@ class OcrccBot {
|
|||||||
this.config = botConfig;
|
this.config = botConfig;
|
||||||
this.client = matrix.createClient(this.config.MATRIX_SERVER_URL);
|
this.client = matrix.createClient(this.config.MATRIX_SERVER_URL);
|
||||||
this.joinedRooms = [];
|
this.joinedRooms = [];
|
||||||
|
this.inactivityTimers = {};
|
||||||
}
|
}
|
||||||
|
|
||||||
createLocalStorage() {
|
createLocalStorage() {
|
||||||
@@ -47,20 +48,20 @@ class OcrccBot {
|
|||||||
return new _nodeLocalstorage.LocalStorage(localStoragePath);
|
return new _nodeLocalstorage.LocalStorage(localStoragePath);
|
||||||
}
|
}
|
||||||
|
|
||||||
sendTextMessage(roomId, msgText, showToUser = null) {
|
async sendTextMessage(roomId, msgText, showToUser = null) {
|
||||||
const content = {
|
const content = {
|
||||||
msgtype: "m.text",
|
msgtype: "m.text",
|
||||||
body: msgText,
|
body: msgText,
|
||||||
showToUser: showToUser
|
showToUser: showToUser
|
||||||
};
|
};
|
||||||
this.sendMessage(roomId, content);
|
await this.sendMessage(roomId, content);
|
||||||
}
|
}
|
||||||
|
|
||||||
async sendNotice(roomId, message) {
|
async sendNotice(roomId, message) {
|
||||||
_logger.default.log("info", `SENDING *NOTICE*: ${message}`);
|
|
||||||
|
|
||||||
try {
|
try {
|
||||||
await this.client.sendNotice(roomId, message);
|
await this.client.sendNotice(roomId, message);
|
||||||
|
|
||||||
|
_logger.default.log("info", `SENT *NOTICE*: ${message}`);
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
switch (err["name"]) {
|
switch (err["name"]) {
|
||||||
case "UnknownDeviceError":
|
case "UnknownDeviceError":
|
||||||
@@ -129,10 +130,9 @@ class OcrccBot {
|
|||||||
}
|
}
|
||||||
|
|
||||||
async inviteFacilitators(roomId) {
|
async inviteFacilitators(roomId) {
|
||||||
|
try {
|
||||||
this.localStorage.setItem(`${roomId}-waiting`, 'true');
|
this.localStorage.setItem(`${roomId}-waiting`, 'true');
|
||||||
let invitations = [];
|
let invitations = [];
|
||||||
|
|
||||||
try {
|
|
||||||
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"]);
|
||||||
members.forEach(memberId => {
|
members.forEach(memberId => {
|
||||||
@@ -159,9 +159,8 @@ class OcrccBot {
|
|||||||
}
|
}
|
||||||
|
|
||||||
async uninviteFacilitators(roomId) {
|
async uninviteFacilitators(roomId) {
|
||||||
this.localStorage.removeItem(`${roomId}-waiting`);
|
|
||||||
|
|
||||||
try {
|
try {
|
||||||
|
this.localStorage.removeItem(`${roomId}-waiting`);
|
||||||
const facilitatorsRoomMembers = await this.client.getJoinedRoomMembers(this.config.FACILITATOR_ROOM_ID);
|
const facilitatorsRoomMembers = await this.client.getJoinedRoomMembers(this.config.FACILITATOR_ROOM_ID);
|
||||||
const supportRoomMembers = await this.client.getJoinedRoomMembers(roomId);
|
const supportRoomMembers = await this.client.getJoinedRoomMembers(roomId);
|
||||||
const roomMembersIds = Object.keys(supportRoomMembers["joined"]);
|
const roomMembersIds = Object.keys(supportRoomMembers["joined"]);
|
||||||
@@ -184,14 +183,23 @@ class OcrccBot {
|
|||||||
this.sendTextMessage(roomId, this.config.BOT_ERROR_MESSAGE);
|
this.sendTextMessage(roomId, this.config.BOT_ERROR_MESSAGE);
|
||||||
}
|
}
|
||||||
|
|
||||||
this.sendTextMessage(this.config.FACILITATOR_ROOM_ID, `The Help Bot ran into an error: ${error}. Please verify that the chat service is working.`);
|
this.sendTextMessage(this.config.FACILITATOR_ROOM_ID, `${this.config.BOT_DISPLAY_NAME} ran into an error: ${error}. Please verify that the chat service is working.`);
|
||||||
}
|
}
|
||||||
|
|
||||||
handleMessageEvent(event) {
|
handleMessageEvent(event) {
|
||||||
const content = event.getContent(); // do nothing if there's no content
|
const content = event.getContent();
|
||||||
|
const sender = event.getSender();
|
||||||
|
const roomId = event.getRoomId(); // do nothing if there's no content
|
||||||
|
|
||||||
if (!content) {
|
if (!content) {
|
||||||
return;
|
return;
|
||||||
|
} // if it's a chat message and the facilitator has joined, reset the inactivity timeout
|
||||||
|
|
||||||
|
|
||||||
|
const facilitatorId = this.localStorage.getItem(`${roomId}-facilitator`);
|
||||||
|
|
||||||
|
if (Boolean(facilitatorId) && sender !== this.config.BOT_USERID) {
|
||||||
|
this.setInactivityTimeout(roomId);
|
||||||
} // bot commands
|
} // bot commands
|
||||||
|
|
||||||
|
|
||||||
@@ -217,7 +225,7 @@ class OcrccBot {
|
|||||||
const filepath = this.localStorage.getItem(`${roomId}-transcript`);
|
const filepath = this.localStorage.getItem(`${roomId}-transcript`);
|
||||||
|
|
||||||
if (!filepath) {
|
if (!filepath) {
|
||||||
return _logger.default.log("error", `NO TRANSCRIPT FILE FOR ROOM: ${roomId}`);
|
return _logger.default.log("error", `NO TRANSCRIPT FILE FOR ROOM: ${roomId}. This message will not be added: ${content.body}`);
|
||||||
}
|
}
|
||||||
|
|
||||||
const message = `${sender} [${time}]: ${content.body}\n`;
|
const message = `${sender} [${time}]: ${content.body}\n`;
|
||||||
@@ -236,8 +244,9 @@ class OcrccBot {
|
|||||||
}, {
|
}, {
|
||||||
keyword: 'delete transcript',
|
keyword: 'delete transcript',
|
||||||
function: (senderId, roomId) => {
|
function: (senderId, roomId) => {
|
||||||
this.deleteTranscript(senderId, roomId);
|
this.deleteTranscript(senderId, roomId, true);
|
||||||
}
|
} // delete transcript and send confirmation message
|
||||||
|
|
||||||
}, {
|
}, {
|
||||||
keyword: 'say',
|
keyword: 'say',
|
||||||
function: (senderId, roomId, message) => {
|
function: (senderId, roomId, message) => {
|
||||||
@@ -270,7 +279,7 @@ class OcrccBot {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
async leaveEmptyRooms(senderId) {
|
async leaveEmptyRooms() {
|
||||||
try {
|
try {
|
||||||
const roomData = await this.client.getJoinedRooms();
|
const roomData = await this.client.getJoinedRooms();
|
||||||
const joinedRoomsIds = roomData["joined_rooms"];
|
const joinedRoomsIds = roomData["joined_rooms"];
|
||||||
@@ -279,16 +288,16 @@ class OcrccBot {
|
|||||||
|
|
||||||
if (room && room.getJoinedMemberCount() === 1) {
|
if (room && room.getJoinedMemberCount() === 1) {
|
||||||
try {
|
try {
|
||||||
_logger.default.log('info', "LEAVING EMPTY ROOM => " + roomId);
|
|
||||||
|
|
||||||
await this.client.leave(roomId);
|
await this.client.leave(roomId);
|
||||||
|
|
||||||
|
_logger.default.log('info', `LEAVING EMPTY ROOM => ${roomId}`);
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
_logger.default.log('error', "ERROR LEAVING EMPTY ROOM => " + err);
|
_logger.default.log('error', `ERROR LEAVING ROOM ${roomId} => ${err}`);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
_logger.default.log("error", `ERROR GETTING JOINED ROOMS: ${err}`);
|
_logger.default.log("error", `ERROR LEAVING EMPTY ROOMS: ${err}`);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -297,7 +306,7 @@ class OcrccBot {
|
|||||||
const transcriptFile = this.localStorage.getItem(`${roomId}-transcript`);
|
const transcriptFile = this.localStorage.getItem(`${roomId}-transcript`);
|
||||||
|
|
||||||
if (!transcriptFile) {
|
if (!transcriptFile) {
|
||||||
this.sendTextMessage(roomId, "There is no transcript for this chat.", senderId);
|
this.sendTextMessage(roomId, "Cannot send transcript, there is no transcript for this chat.", senderId);
|
||||||
}
|
}
|
||||||
|
|
||||||
if (this.client.isRoomEncrypted(roomId)) {
|
if (this.client.isRoomEncrypted(roomId)) {
|
||||||
@@ -356,11 +365,11 @@ class OcrccBot {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
deleteTranscript(senderId, roomId) {
|
deleteTranscript(senderId, roomId, sendConfirmation = false) {
|
||||||
const transcriptFile = this.localStorage.getItem(`${roomId}-transcript`);
|
const transcriptFile = this.localStorage.getItem(`${roomId}-transcript`);
|
||||||
|
|
||||||
if (!transcriptFile) {
|
if (!transcriptFile) {
|
||||||
return this.sendTextMessage(roomId, "There is no transcript for this chat.", senderId);
|
return this.sendTextMessage(roomId, "Cannot delete transcript, there is no transcript for this chat.", senderId);
|
||||||
}
|
}
|
||||||
|
|
||||||
fs.unlink(transcriptFile, err => {
|
fs.unlink(transcriptFile, err => {
|
||||||
@@ -372,11 +381,13 @@ class OcrccBot {
|
|||||||
return this.sendTextMessage(roomId, `There was an error deleting the transcript: ${err}`, senderId);
|
return this.sendTextMessage(roomId, `There was an error deleting the transcript: ${err}`, senderId);
|
||||||
}
|
}
|
||||||
|
|
||||||
this.localStorage.removeItem(`${roomId}-transcript`);
|
if (sendConfirmation) {
|
||||||
|
this.sendTextMessage(roomId, `The transcript file has been deleted.`, senderId);
|
||||||
|
}
|
||||||
|
|
||||||
_logger.default.log('info', "DELETED TRANSCRIPT FILE => " + transcriptFile);
|
_logger.default.log('info', "DELETED TRANSCRIPT FILE => " + transcriptFile);
|
||||||
|
|
||||||
this.sendTextMessage(roomId, `The transcript file has been deleted.`, senderId);
|
this.localStorage.removeItem(`${roomId}-transcript`);
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -434,6 +445,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.setTimeoutforFacilitator(room.roomId);
|
||||||
}
|
}
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
_logger.default.log("error", "ERROR JOINING ROOM => " + err);
|
_logger.default.log("error", "ERROR JOINING ROOM => " + err);
|
||||||
@@ -441,6 +453,7 @@ class OcrccBot {
|
|||||||
}
|
}
|
||||||
|
|
||||||
if (member.membership === "join" && member.userId !== this.config.BOT_USERID && this.localStorage.getItem(`${member.roomId}-waiting`)) {
|
if (member.membership === "join" && member.userId !== this.config.BOT_USERID && 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"]);
|
||||||
@@ -490,43 +503,56 @@ class OcrccBot {
|
|||||||
this.localStorage.setItem(`${member.roomId}-transcript`, filepath);
|
this.localStorage.setItem(`${member.roomId}-transcript`, filepath);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
} catch (err) {
|
||||||
|
_logger.default.log("error", `ERROR WHEN FACILITATOR JOINED ROOM ==> ${err}`);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
if (member.membership === "leave" && member.userId !== this.config.BOT_USERID) {
|
if (member.membership === "leave" && member.userId !== this.config.BOT_USERID) {
|
||||||
// ensure bot is still in the room
|
|
||||||
const roomData = await this.client.getJoinedRooms();
|
|
||||||
const joinedRooms = roomData["joined_rooms"];
|
|
||||||
const isBotInRoom = joinedRooms.includes(member.roomId);
|
|
||||||
const room = this.client.getRoom(member.roomId);
|
const room = this.client.getRoom(member.roomId);
|
||||||
if (!room) return; // notify room if the facilitator has left
|
if (!room) return;
|
||||||
|
const roomMembers = await room.getJoinedMembers(); // array
|
||||||
|
|
||||||
const facilitatorId = this.localStorage.getItem(`${member.roomId}-facilitator`);
|
const facilitatorRoomMembers = await this.client.getJoinedRoomMembers(this.config.FACILITATOR_ROOM_ID); // object
|
||||||
|
|
||||||
if (isBotInRoom && member.userId === facilitatorId) {
|
|
||||||
this.sendTextMessage(member.roomId, `${member.name} has left the chat.`);
|
|
||||||
} // leave if there is nobody in the room
|
|
||||||
|
|
||||||
|
const isBotInRoom = Boolean(roomMembers.find(member => member.userId === this.config.BOT_USERID)); // leave if there is nobody in the room
|
||||||
|
|
||||||
try {
|
try {
|
||||||
const memberCount = room.getJoinedMemberCount();
|
const memberCount = roomMembers.length;
|
||||||
|
|
||||||
if (memberCount === 1 && isBotInRoom) {
|
if (memberCount === 1 && isBotInRoom) {
|
||||||
// just the bot left
|
// just the bot left
|
||||||
_logger.default.log("info", `LEAVING EMPTY ROOM ==> ${member.roomId}`);
|
_logger.default.log("info", `LEAVING EMPTY ROOM: ${member.roomId}`);
|
||||||
|
|
||||||
this.deleteTranscript(member.userId, member.roomId);
|
this.deleteTranscript(member.userId, member.roomId);
|
||||||
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);
|
this.localStorage.removeItem(`${member.roomId}-waiting`);
|
||||||
|
return await this.client.leave(member.roomId);
|
||||||
}
|
}
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
_logger.default.log("error", `ERROR LEAVING EMPTY ROOM ==> ${err}`);
|
return _logger.default.log("error", `ERROR LEAVING EMPTY ROOM ==> ${err}`);
|
||||||
|
} // notify room if the facilitator has left
|
||||||
|
|
||||||
|
|
||||||
|
try {
|
||||||
|
const facilitatorId = this.localStorage.getItem(`${member.roomId}-facilitator`);
|
||||||
|
|
||||||
|
if (isBotInRoom && member.userId === facilitatorId) {
|
||||||
|
this.sendTextMessage(member.roomId, `${member.name} has left the chat.`); // send notification to Support Chat Notifications room
|
||||||
|
|
||||||
|
const currentDate = new Date();
|
||||||
|
const chatTime = currentDate.toLocaleTimeString();
|
||||||
|
const roomId = member.roomId.split(':')[0];
|
||||||
|
const notification = `${member.name} left the chat at ${chatTime} (room ID: ${roomId})`;
|
||||||
|
await this.sendTextMessage(this.config.FACILITATOR_ROOM_ID, notification);
|
||||||
|
}
|
||||||
|
} catch (err) {
|
||||||
|
_logger.default.log("error", `ERROR NOTIFYING THAT FACLITATOR HAS LEFT THE ROOM ==> ${err}`);
|
||||||
} // send signal to close the chat if there are no facilitators in the room
|
} // send signal to close the chat if there are no facilitators in the room
|
||||||
|
|
||||||
|
|
||||||
try {
|
try {
|
||||||
const roomMembers = await room.getJoinedMembers();
|
|
||||||
const facilitatorRoomMembers = await this.client.getJoinedRoomMembers(this.config.FACILITATOR_ROOM_ID);
|
|
||||||
const facilitators = facilitatorRoomMembers['joined'];
|
const facilitators = facilitatorRoomMembers['joined'];
|
||||||
let facilitatorInRoom = false;
|
let facilitatorInRoom = false;
|
||||||
roomMembers.forEach(member => {
|
roomMembers.forEach(member => {
|
||||||
@@ -536,6 +562,8 @@ class OcrccBot {
|
|||||||
});
|
});
|
||||||
|
|
||||||
if (!facilitatorInRoom) {
|
if (!facilitatorInRoom) {
|
||||||
|
_logger.default.log("info", `NO FACILITATORS LEFT, SENDING SIGNAL TO END CHAT`);
|
||||||
|
|
||||||
this.sendBotSignal(member.roomId, BOT_SIGNAL_END_CHAT);
|
this.sendBotSignal(member.roomId, BOT_SIGNAL_END_CHAT);
|
||||||
}
|
}
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
@@ -545,6 +573,30 @@ class OcrccBot {
|
|||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
|
setTimeoutforFacilitator(roomId) {
|
||||||
|
setTimeout(() => {
|
||||||
|
const stillWaiting = this.localStorage.getItem(`${roomId}-waiting`);
|
||||||
|
|
||||||
|
if (stillWaiting) {
|
||||||
|
this.sendBotSignal(roomId, BOT_SIGNAL_END_CHAT);
|
||||||
|
}
|
||||||
|
}, this.config.MAX_WAIT_TIME);
|
||||||
|
}
|
||||||
|
|
||||||
|
setInactivityTimeout(roomId) {
|
||||||
|
const oldTimeout = this.inactivityTimers[roomId];
|
||||||
|
|
||||||
|
if (oldTimeout) {
|
||||||
|
clearTimeout(oldTimeout);
|
||||||
|
}
|
||||||
|
|
||||||
|
const newTimeout = setTimeout(() => {
|
||||||
|
this.sendTextMessage(roomId, `This chat has been closed due to inactivity.`);
|
||||||
|
this.sendBotSignal(roomId, BOT_SIGNAL_END_CHAT);
|
||||||
|
}, this.config.MAX_INACTIVE);
|
||||||
|
this.inactivityTimers[roomId] = newTimeout;
|
||||||
|
}
|
||||||
|
|
||||||
async setMessageListeners() {
|
async setMessageListeners() {
|
||||||
// encrypted messages
|
// encrypted messages
|
||||||
this.client.on("Event.decrypted", (event, err) => {
|
this.client.on("Event.decrypted", (event, err) => {
|
||||||
@@ -564,30 +616,23 @@ class OcrccBot {
|
|||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
async leaveOldRooms() {
|
|
||||||
const roomData = await this.client.getJoinedRooms();
|
|
||||||
roomData["joined_rooms"].forEach(async roomId => {
|
|
||||||
try {
|
|
||||||
await this.client.leave(roomId);
|
|
||||||
} catch (err) {
|
|
||||||
_logger.default.log('error', "ERROR LEAVING ROOM => " + err);
|
|
||||||
}
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
async sendBotSignal(roomId, signal, args) {
|
async sendBotSignal(roomId, signal, args) {
|
||||||
let content = {
|
let content = {
|
||||||
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.default.log('error', "ERROR SENDING BOT SIGNAL => " + err);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
async start() {
|
async start() {
|
||||||
|
try {
|
||||||
const localStorage = this.createLocalStorage();
|
const localStorage = this.createLocalStorage();
|
||||||
this.localStorage = localStorage;
|
this.localStorage = localStorage;
|
||||||
|
|
||||||
try {
|
|
||||||
const auth = {
|
const auth = {
|
||||||
user: this.config.BOT_USERNAME,
|
user: this.config.BOT_USERNAME,
|
||||||
password: this.config.BOT_PASSWORD,
|
password: this.config.BOT_PASSWORD,
|
||||||
@@ -614,6 +659,7 @@ class OcrccBot {
|
|||||||
|
|
||||||
if (state === 'PREPARED') {
|
if (state === 'PREPARED') {
|
||||||
await this.deleteOldDevices();
|
await this.deleteOldDevices();
|
||||||
|
await this.leaveEmptyRooms();
|
||||||
await this.trackJoinedRooms();
|
await this.trackJoinedRooms();
|
||||||
await this.setMembershipListeners();
|
await this.setMembershipListeners();
|
||||||
await this.setMessageListeners();
|
await this.setMessageListeners();
|
||||||
|
|||||||
14
dist/bot.test.js
vendored
14
dist/bot.test.js
vendored
@@ -103,6 +103,8 @@ describe('OcrccBot', () => {
|
|||||||
mockAppendFileSync.mockClear();
|
mockAppendFileSync.mockClear();
|
||||||
|
|
||||||
_matrixJsSdk.mockGetGroupUsers.mockClear();
|
_matrixJsSdk.mockGetGroupUsers.mockClear();
|
||||||
|
|
||||||
|
_matrixJsSdk.mockSendStateEvent.mockClear();
|
||||||
});
|
});
|
||||||
test('constructor should inititialize class variables', () => {
|
test('constructor should inititialize class variables', () => {
|
||||||
const bot = new _bot.default(botConfig);
|
const bot = new _bot.default(botConfig);
|
||||||
@@ -276,4 +278,16 @@ describe('OcrccBot', () => {
|
|||||||
expect(_matrixJsSdk.mockStartClient).toHaveBeenCalled();
|
expect(_matrixJsSdk.mockStartClient).toHaveBeenCalled();
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
test('#sendBotSignal should send custom state event', () => {
|
||||||
|
const bot = new _bot.default(botConfig);
|
||||||
|
bot.start();
|
||||||
|
const test_room_id = 'test_room_id';
|
||||||
|
const signal = 'END_CHAT';
|
||||||
|
bot.sendBotSignal(test_room_id, signal);
|
||||||
|
(0, _waitForExpect.default)(() => {
|
||||||
|
expect(_matrixJsSdk.mockSendStateEvent).toHaveBeenCalledWith(test_room_id, 'm.bot.signal', {
|
||||||
|
signal
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
||||||
});
|
});
|
||||||
17
dist/index.js
vendored
17
dist/index.js
vendored
@@ -19,7 +19,10 @@ const {
|
|||||||
BOT_PASSWORD,
|
BOT_PASSWORD,
|
||||||
BOT_DISPLAY_NAME,
|
BOT_DISPLAY_NAME,
|
||||||
FACILITATOR_ROOM_ID,
|
FACILITATOR_ROOM_ID,
|
||||||
CAPTURE_TRANSCRIPTS
|
CAPTURE_TRANSCRIPTS,
|
||||||
|
CHAT_NOT_AVAILABLE_MESSAGE,
|
||||||
|
MAX_WAIT_TIME,
|
||||||
|
MAX_INACTIVE
|
||||||
} = process.env;
|
} = process.env;
|
||||||
const botConfig = {
|
const botConfig = {
|
||||||
ENCRYPTION_CONFIG,
|
ENCRYPTION_CONFIG,
|
||||||
@@ -32,7 +35,15 @@ const botConfig = {
|
|||||||
BOT_PASSWORD,
|
BOT_PASSWORD,
|
||||||
BOT_DISPLAY_NAME,
|
BOT_DISPLAY_NAME,
|
||||||
FACILITATOR_ROOM_ID,
|
FACILITATOR_ROOM_ID,
|
||||||
CAPTURE_TRANSCRIPTS
|
CAPTURE_TRANSCRIPTS,
|
||||||
|
CHAT_NOT_AVAILABLE_MESSAGE,
|
||||||
|
MAX_WAIT_TIME,
|
||||||
|
MAX_INACTIVE
|
||||||
};
|
};
|
||||||
const bot = new _bot.default(botConfig);
|
const bot = new _bot.default(botConfig);
|
||||||
bot.start();
|
|
||||||
|
try {
|
||||||
|
bot.start();
|
||||||
|
} catch (err) {
|
||||||
|
console.log("AAAAAAAAAAAAA", err);
|
||||||
|
}
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "private-safesupport-bot",
|
"name": "private-safesupport-bot",
|
||||||
"version": "1.2.0",
|
"version": "2.0.1",
|
||||||
"description": "Chatbot to manage interactions on Safe Support Chat",
|
"description": "Chatbot to manage interactions on Safe Support Chat",
|
||||||
"main": "dist/index.js",
|
"main": "dist/index.js",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
|
|||||||
94
src/bot.js
94
src/bot.js
@@ -32,21 +32,20 @@ class OcrccBot {
|
|||||||
return new LocalStorage(localStoragePath);
|
return new LocalStorage(localStoragePath);
|
||||||
}
|
}
|
||||||
|
|
||||||
sendTextMessage(roomId, msgText, showToUser = null) {
|
async sendTextMessage(roomId, msgText, showToUser = null) {
|
||||||
const content = {
|
const content = {
|
||||||
msgtype: "m.text",
|
msgtype: "m.text",
|
||||||
body: msgText,
|
body: msgText,
|
||||||
showToUser: showToUser
|
showToUser: showToUser
|
||||||
};
|
};
|
||||||
|
|
||||||
this.sendMessage(roomId, content);
|
await this.sendMessage(roomId, content);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
async sendNotice(roomId, message) {
|
async sendNotice(roomId, message) {
|
||||||
logger.log("info", `SENDING *NOTICE*: ${message}`)
|
|
||||||
try {
|
try {
|
||||||
await this.client.sendNotice(roomId, message)
|
await this.client.sendNotice(roomId, message)
|
||||||
|
logger.log("info", `SENT *NOTICE*: ${message}`)
|
||||||
} catch(err) {
|
} catch(err) {
|
||||||
switch (err["name"]) {
|
switch (err["name"]) {
|
||||||
case "UnknownDeviceError":
|
case "UnknownDeviceError":
|
||||||
@@ -109,10 +108,9 @@ class OcrccBot {
|
|||||||
}
|
}
|
||||||
|
|
||||||
async inviteFacilitators(roomId) {
|
async inviteFacilitators(roomId) {
|
||||||
|
try {
|
||||||
this.localStorage.setItem(`${roomId}-waiting`, 'true')
|
this.localStorage.setItem(`${roomId}-waiting`, 'true')
|
||||||
let invitations = []
|
let invitations = []
|
||||||
|
|
||||||
try {
|
|
||||||
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"]);
|
||||||
|
|
||||||
@@ -143,9 +141,8 @@ class OcrccBot {
|
|||||||
|
|
||||||
|
|
||||||
async uninviteFacilitators(roomId) {
|
async uninviteFacilitators(roomId) {
|
||||||
this.localStorage.removeItem(`${roomId}-waiting`)
|
|
||||||
|
|
||||||
try {
|
try {
|
||||||
|
this.localStorage.removeItem(`${roomId}-waiting`)
|
||||||
const facilitatorsRoomMembers = await this.client.getJoinedRoomMembers(this.config.FACILITATOR_ROOM_ID)
|
const facilitatorsRoomMembers = await this.client.getJoinedRoomMembers(this.config.FACILITATOR_ROOM_ID)
|
||||||
const supportRoomMembers = await this.client.getJoinedRoomMembers(roomId)
|
const supportRoomMembers = await this.client.getJoinedRoomMembers(roomId)
|
||||||
|
|
||||||
@@ -173,7 +170,7 @@ class OcrccBot {
|
|||||||
|
|
||||||
this.sendTextMessage(
|
this.sendTextMessage(
|
||||||
this.config.FACILITATOR_ROOM_ID,
|
this.config.FACILITATOR_ROOM_ID,
|
||||||
`The Help Bot ran into an error: ${error}. Please verify that the chat service is working.`
|
`${this.config.BOT_DISPLAY_NAME} ran into an error: ${error}. Please verify that the chat service is working.`
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -216,7 +213,7 @@ class OcrccBot {
|
|||||||
const filepath = this.localStorage.getItem(`${roomId}-transcript`)
|
const filepath = this.localStorage.getItem(`${roomId}-transcript`)
|
||||||
|
|
||||||
if (!filepath) {
|
if (!filepath) {
|
||||||
return logger.log("error", `NO TRANSCRIPT FILE FOR ROOM: ${roomId}`);
|
return logger.log("error", `NO TRANSCRIPT FILE FOR ROOM: ${roomId}. This message will not be added: ${content.body}`);
|
||||||
}
|
}
|
||||||
|
|
||||||
const message = `${sender} [${time}]: ${content.body}\n`;
|
const message = `${sender} [${time}]: ${content.body}\n`;
|
||||||
@@ -235,7 +232,7 @@ class OcrccBot {
|
|||||||
},
|
},
|
||||||
{
|
{
|
||||||
keyword: 'delete transcript',
|
keyword: 'delete transcript',
|
||||||
function: (senderId, roomId) => { this.deleteTranscript(senderId, roomId) }
|
function: (senderId, roomId) => { this.deleteTranscript(senderId, roomId, true) } // delete transcript and send confirmation message
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
keyword: 'say',
|
keyword: 'say',
|
||||||
@@ -280,7 +277,7 @@ class OcrccBot {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
async leaveEmptyRooms(senderId) {
|
async leaveEmptyRooms() {
|
||||||
try {
|
try {
|
||||||
const roomData = await this.client.getJoinedRooms()
|
const roomData = await this.client.getJoinedRooms()
|
||||||
const joinedRoomsIds = roomData["joined_rooms"]
|
const joinedRoomsIds = roomData["joined_rooms"]
|
||||||
@@ -288,15 +285,15 @@ class OcrccBot {
|
|||||||
const room = this.client.getRoom(roomId)
|
const room = this.client.getRoom(roomId)
|
||||||
if (room && room.getJoinedMemberCount() === 1) {
|
if (room && room.getJoinedMemberCount() === 1) {
|
||||||
try {
|
try {
|
||||||
logger.log('info', "LEAVING EMPTY ROOM => " + roomId)
|
|
||||||
await this.client.leave(roomId)
|
await this.client.leave(roomId)
|
||||||
|
logger.log('info', `LEAVING EMPTY ROOM => ${roomId}`)
|
||||||
} catch(err) {
|
} catch(err) {
|
||||||
logger.log('error', "ERROR LEAVING EMPTY ROOM => " + err)
|
logger.log('error', `ERROR LEAVING ROOM ${roomId} => ${err}`)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
} catch(err) {
|
} catch(err) {
|
||||||
logger.log("error", `ERROR GETTING JOINED ROOMS: ${err}`);
|
logger.log("error", `ERROR LEAVING EMPTY ROOMS: ${err}`);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -307,7 +304,7 @@ class OcrccBot {
|
|||||||
if (!transcriptFile) {
|
if (!transcriptFile) {
|
||||||
this.sendTextMessage(
|
this.sendTextMessage(
|
||||||
roomId,
|
roomId,
|
||||||
"There is no transcript for this chat.",
|
"Cannot send transcript, there is no transcript for this chat.",
|
||||||
senderId
|
senderId
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
@@ -370,13 +367,13 @@ class OcrccBot {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
deleteTranscript(senderId, roomId) {
|
deleteTranscript(senderId, roomId, sendConfirmation=false) {
|
||||||
const transcriptFile = this.localStorage.getItem(`${roomId}-transcript`)
|
const transcriptFile = this.localStorage.getItem(`${roomId}-transcript`)
|
||||||
|
|
||||||
if (!transcriptFile) {
|
if (!transcriptFile) {
|
||||||
return this.sendTextMessage(
|
return this.sendTextMessage(
|
||||||
roomId,
|
roomId,
|
||||||
"There is no transcript for this chat.",
|
"Cannot delete transcript, there is no transcript for this chat.",
|
||||||
senderId
|
senderId
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
@@ -392,13 +389,17 @@ class OcrccBot {
|
|||||||
senderId
|
senderId
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
this.localStorage.removeItem(`${roomId}-transcript`)
|
|
||||||
logger.log('info', "DELETED TRANSCRIPT FILE => " + transcriptFile)
|
if (sendConfirmation) {
|
||||||
this.sendTextMessage(
|
this.sendTextMessage(
|
||||||
roomId,
|
roomId,
|
||||||
`The transcript file has been deleted.`,
|
`The transcript file has been deleted.`,
|
||||||
senderId
|
senderId
|
||||||
);
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
logger.log('info', "DELETED TRANSCRIPT FILE => " + transcriptFile)
|
||||||
|
this.localStorage.removeItem(`${roomId}-transcript`)
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -535,7 +536,22 @@ class OcrccBot {
|
|||||||
|
|
||||||
const roomMembers = await room.getJoinedMembers() // array
|
const roomMembers = await room.getJoinedMembers() // array
|
||||||
const facilitatorRoomMembers = await this.client.getJoinedRoomMembers(this.config.FACILITATOR_ROOM_ID) // object
|
const facilitatorRoomMembers = await this.client.getJoinedRoomMembers(this.config.FACILITATOR_ROOM_ID) // object
|
||||||
const isBotInRoom = roomMembers.find(member => member.userId === this.config.BOT_USERID)
|
const isBotInRoom = Boolean(roomMembers.find(member => member.userId === this.config.BOT_USERID))
|
||||||
|
|
||||||
|
// leave if there is nobody in the room
|
||||||
|
try {
|
||||||
|
const memberCount = roomMembers.length
|
||||||
|
if (memberCount === 1 && isBotInRoom) { // just the bot left
|
||||||
|
logger.log("info", `LEAVING EMPTY ROOM: ${member.roomId}`);
|
||||||
|
this.deleteTranscript(member.userId, member.roomId);
|
||||||
|
this.localStorage.removeItem(`${member.roomId}-facilitator`)
|
||||||
|
this.localStorage.removeItem(`${member.roomId}-transcript`)
|
||||||
|
this.localStorage.removeItem(`${member.roomId}-waiting`)
|
||||||
|
return await this.client.leave(member.roomId)
|
||||||
|
}
|
||||||
|
} catch(err) {
|
||||||
|
return logger.log("error", `ERROR LEAVING EMPTY ROOM ==> ${err}`);
|
||||||
|
}
|
||||||
|
|
||||||
// notify room if the facilitator has left
|
// notify room if the facilitator has left
|
||||||
try {
|
try {
|
||||||
@@ -545,25 +561,17 @@ class OcrccBot {
|
|||||||
member.roomId,
|
member.roomId,
|
||||||
`${member.name} has left the chat.`
|
`${member.name} has left the chat.`
|
||||||
);
|
);
|
||||||
|
// send notification to Support Chat Notifications room
|
||||||
|
const currentDate = new Date()
|
||||||
|
const chatTime = currentDate.toLocaleTimeString()
|
||||||
|
const roomId = member.roomId.split(':')[0]
|
||||||
|
const notification = `${member.name} left the chat at ${chatTime} (room ID: ${roomId})`
|
||||||
|
await this.sendTextMessage(this.config.FACILITATOR_ROOM_ID, notification);
|
||||||
}
|
}
|
||||||
} catch(err) {
|
} catch(err) {
|
||||||
logger.log("error", `ERROR NOTIFYING THAT FACLITATOR HAS LEFT THE ROOM ==> ${err}`);
|
logger.log("error", `ERROR NOTIFYING THAT FACLITATOR HAS LEFT THE ROOM ==> ${err}`);
|
||||||
}
|
}
|
||||||
|
|
||||||
// leave if there is nobody in the room
|
|
||||||
try {
|
|
||||||
const memberCount = roomMembers.length
|
|
||||||
if (memberCount === 1 && isBotInRoom) { // just the bot left
|
|
||||||
logger.log("info", `LEAVING EMPTY ROOM ==> ${member.roomId}`);
|
|
||||||
this.deleteTranscript(member.userId, member.roomId);
|
|
||||||
this.localStorage.removeItem(`${member.roomId}-facilitator`)
|
|
||||||
this.localStorage.removeItem(`${member.roomId}-transcript`)
|
|
||||||
return this.client.leave(member.roomId)
|
|
||||||
}
|
|
||||||
} catch(err) {
|
|
||||||
logger.log("error", `ERROR LEAVING EMPTY ROOM ==> ${err}`);
|
|
||||||
}
|
|
||||||
|
|
||||||
// send signal to close the chat if there are no facilitators in the room
|
// send signal to close the chat if there are no facilitators in the room
|
||||||
try {
|
try {
|
||||||
const facilitators = facilitatorRoomMembers['joined']
|
const facilitators = facilitatorRoomMembers['joined']
|
||||||
@@ -576,6 +584,7 @@ class OcrccBot {
|
|||||||
})
|
})
|
||||||
|
|
||||||
if (!facilitatorInRoom) {
|
if (!facilitatorInRoom) {
|
||||||
|
logger.log("info", `NO FACILITATORS LEFT, SENDING SIGNAL TO END CHAT`);
|
||||||
this.sendBotSignal(member.roomId, BOT_SIGNAL_END_CHAT)
|
this.sendBotSignal(member.roomId, BOT_SIGNAL_END_CHAT)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -631,18 +640,6 @@ class OcrccBot {
|
|||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
async leaveOldRooms() {
|
|
||||||
const roomData = await this.client.getJoinedRooms()
|
|
||||||
|
|
||||||
roomData["joined_rooms"].forEach(async roomId => {
|
|
||||||
try {
|
|
||||||
await this.client.leave(roomId)
|
|
||||||
} catch(err) {
|
|
||||||
logger.log('error', "ERROR LEAVING ROOM => " + err)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
async sendBotSignal (roomId, signal, args) {
|
async sendBotSignal (roomId, signal, args) {
|
||||||
let content = {
|
let content = {
|
||||||
signal: signal,
|
signal: signal,
|
||||||
@@ -656,10 +653,10 @@ class OcrccBot {
|
|||||||
}
|
}
|
||||||
|
|
||||||
async start() {
|
async start() {
|
||||||
|
try {
|
||||||
const localStorage = this.createLocalStorage();
|
const localStorage = this.createLocalStorage();
|
||||||
this.localStorage = localStorage
|
this.localStorage = localStorage
|
||||||
|
|
||||||
try {
|
|
||||||
const auth = {
|
const auth = {
|
||||||
user: this.config.BOT_USERNAME,
|
user: this.config.BOT_USERNAME,
|
||||||
password: this.config.BOT_PASSWORD,
|
password: this.config.BOT_PASSWORD,
|
||||||
@@ -684,6 +681,7 @@ class OcrccBot {
|
|||||||
logger.log("info", `SYNC STATUS: ${state}`)
|
logger.log("info", `SYNC STATUS: ${state}`)
|
||||||
if (state === 'PREPARED') {
|
if (state === 'PREPARED') {
|
||||||
await this.deleteOldDevices()
|
await this.deleteOldDevices()
|
||||||
|
await this.leaveEmptyRooms()
|
||||||
await this.trackJoinedRooms()
|
await this.trackJoinedRooms()
|
||||||
await this.setMembershipListeners();
|
await this.setMembershipListeners();
|
||||||
await this.setMessageListeners();
|
await this.setMessageListeners();
|
||||||
|
|||||||
@@ -39,4 +39,8 @@ const botConfig = {
|
|||||||
import OcrccBot from './bot'
|
import OcrccBot from './bot'
|
||||||
|
|
||||||
const bot = new OcrccBot(botConfig);
|
const bot = new OcrccBot(botConfig);
|
||||||
bot.start();
|
try {
|
||||||
|
bot.start();
|
||||||
|
} catch(err) {
|
||||||
|
console.log("AAAAAAAAAAAAA", err)
|
||||||
|
}
|
||||||
|
|||||||
Reference in New Issue
Block a user