Skip to content

Node.js based forum software built for the modern web

refactor: remove deprecated chat socket.io methods

Barış Soner Uşaklıa2aa265ba1a1
diff --git a/src/socket.io/modules.js b/src/socket.io/modules.js
index b5624cca43..65ed76cdd1 100644
--- a/src/socket.io/modules.js
+++ b/src/socket.io/modules.js
@@ -6,12 +6,9 @@
*/
const Messaging = require('../messaging');
-const utils = require('../utils');
const user = require('../user');
const groups = require('../groups');
-const api = require('../api');
-const sockets = require('.');
const SocketModules = module.exports;
@@ -20,81 +17,6 @@ SocketModules.settings = {};
/* Chat */
-SocketModules.chats.getRaw = async function (socket, data) {
- sockets.warnDeprecated(socket, 'GET /api/v3/chats/:roomId/messages/:mid/raw');
-
- if (!data || !data.hasOwnProperty('mid')) {
- throw new Error('[[error:invalid-data]]');
- }
- const roomId = await Messaging.getMessageField(data.mid, 'roomId');
-
- const { content } = await api.chats.getRawMessage(socket, {
- mid: data.mid,
- roomId,
- });
-
- return content;
-};
-
-SocketModules.chats.isDnD = async function (socket, uid) {
- sockets.warnDeprecated(socket, 'GET /api/v3/users/:uid/status OR HEAD /api/v3/users/:uid/status/:status');
-
- const { status } = await api.users.getStatus(socket, { uid });
- return status === 'dnd';
-};
-
-SocketModules.chats.canMessage = async function (socket, roomId) {
- sockets.warnDeprecated(socket);
-
- await Messaging.canMessageRoom(socket.uid, roomId);
-};
-
-SocketModules.chats.markAllRead = async function (socket) {
- sockets.warnDeprecated(socket);
-
- await Messaging.markAllRead(socket.uid);
- Messaging.pushUnreadCount(socket.uid);
-};
-
-SocketModules.chats.getRecentChats = async function (socket, data) {
- sockets.warnDeprecated(socket, 'GET /api/v3/chats');
-
- if (!data || !utils.isNumber(data.after) || !utils.isNumber(data.uid)) {
- throw new Error('[[error:invalid-data]]');
- }
- const start = parseInt(data.after, 10);
- const stop = start + 9;
- const { uid } = data;
-
- return api.chats.list(socket, { uid, start, stop });
-};
-
-SocketModules.chats.hasPrivateChat = async function (socket, uid) {
- sockets.warnDeprecated(socket, 'GET /api/v3/users/:uid/chat');
-
- if (socket.uid <= 0 || uid <= 0) {
- throw new Error('[[error:invalid-data]]');
- }
-
- // despite the `has` prefix, this method actually did return the roomId.
- const { roomId } = await api.users.getPrivateRoomId(socket, { uid });
- return roomId;
-};
-
-SocketModules.chats.getIP = async function (socket, mid) {
- sockets.warnDeprecated(socket, 'GET /api/v3/chats/:roomId/messages/:mid/ip');
-
- const { ip } = await api.chats.getIpAddress(socket, { mid });
- return ip;
-};
-
-SocketModules.chats.getUnreadCount = async function (socket) {
- sockets.warnDeprecated(socket, 'GET /api/v3/chats/unread');
-
- const { count } = await api.chats.getUnread(socket);
- return count;
-};
-
SocketModules.chats.enter = async function (socket, roomIds) {
await joinLeave(socket, roomIds, 'join');
};
@@ -141,59 +63,4 @@ async function joinLeave(socket, roomIds, method, prefix = 'chat_room') {
}
}
-SocketModules.chats.sortPublicRooms = async function (socket, data) {
- sockets.warnDeprecated(socket, 'PUT /api/v3/chats/sort');
-
- if (!data) {
- throw new Error('[[error:invalid-data]]');
- }
-
- await api.chats.sortPublicRooms(socket, data);
-};
-
-SocketModules.chats.toggleOwner = async (socket, data) => {
- sockets.warnDeprecated(socket, 'PUT/DELETE /api/v3/chats/:roomId/owners/:uid');
-
- if (!data || !data.uid || !utils.isNumber(data.roomId)) {
- throw new Error('[[error:invalid-data]]');
- }
-
- await api.chats.toggleOwner(socket, data);
-};
-
-SocketModules.chats.setNotificationSetting = async (socket, data) => {
- sockets.warnDeprecated(socket, 'PUT/DELETE /api/v3/chats/:roomId/watch');
-
- if (!data || !utils.isNumber(data.value) || !utils.isNumber(data.roomId)) {
- throw new Error('[[error:invalid-data]]');
- }
-
- await api.chats.watch(socket, data);
-};
-
-SocketModules.chats.loadPinnedMessages = async (socket, data) => {
- sockets.warnDeprecated(socket, 'GET /api/v3/chats/:roomId/messages/pinned');
-
- if (!data || !utils.isNumber(data.roomId) || !utils.isNumber(data.start)) {
- throw new Error('[[error:invalid-data]]');
- }
-
- const { messages } = await api.chats.getPinnedMessages(socket, data);
- return messages;
-};
-
-SocketModules.chats.typing = async (socket, data) => {
- sockets.warnDeprecated(socket, 'PUT /api/v3/chats/:roomId/typing');
-
- if (!data) {
- throw new Error('[[error:invalid-data]]');
- }
-
- // `username` is now inferred from caller uid
- delete data.username;
-
- await api.chats.toggleTyping(socket, data);
-};
-
-
require('../promisify')(SocketModules);
diff --git a/test/socket.io.js b/test/socket.io.js
index 09d998673f..69e2ea7b2f 100644
--- a/test/socket.io.js
+++ b/test/socket.io.js
@@ -463,6 +463,47 @@ describe('socket.io', () => {
}).catch(err => assert.fail(err.message));
});
+ describe('chat enter/leave', () => {
+ const socketModules = require('../src/socket.io/modules');
+
+ it('should error for uid < 0', async () => {
+ const socket = { uid: 0 };
+ const error = { message: '[[error:not-allowed]]' };
+ await assert.rejects(socketModules.chats.enter(socket, [1]), error);
+ await assert.rejects(socketModules.chats.leave(socket, [1]), error);
+ await assert.rejects(socketModules.chats.enterPublic(socket, [1]), error);
+ await assert.rejects(socketModules.chats.leavePublic(socket, [1]), error);
+ });
+
+ it('should do nothing if roomIds is empty', async () => {
+ const socket = { uid: adminUid };
+ await socketModules.chats.enter(socket, []);
+ await socketModules.chats.leave(socket, []);
+ await socketModules.chats.enterPublic(socket, []);
+ await socketModules.chats.leavePublic(socket, []);
+ });
+
+ it('should call socket.join/leave', async () => {
+ let roomName = '';
+ const socket = {
+ uid: adminUid,
+ join: (rn) => { roomName = rn; },
+ leave: (rn) => { roomName = rn; },
+ };
+ await socketModules.chats.enter(socket, [1]);
+ assert.equal(roomName, 'chat_room_1');
+
+ await socketModules.chats.enterPublic(socket, [2]);
+ assert.equal(roomName, 'chat_room_public_2');
+
+ await socketModules.chats.leave(socket, 3); // non-array roomId works as well
+ assert.equal(roomName, 'chat_room_3');
+
+ await socketModules.chats.leavePublic(socket, 4);
+ assert.equal(roomName, 'chat_room_public_4');
+ });
+ });
+
describe('install/upgrade plugin', () => {
it('should install a plugin', function (done) {
this.timeout(0);