From 2fe53cf8493eaab7be044eab151dd74284429405 Mon Sep 17 00:00:00 2001 From: Julian Lam Date: Wed, 22 Dec 2021 15:19:37 -0500 Subject: [PATCH] feat: `GET /api/v3/chats/:roomId/messages` --- public/openapi/write.yaml | 2 + .../openapi/write/chats/roomId/messages.yaml | 54 +++++++++++++++++++ public/src/client/chats.js | 13 ++--- src/controllers/write/chats.js | 12 +++++ src/routes/write/chats.js | 1 + src/socket.io/modules.js | 2 + 6 files changed, 75 insertions(+), 9 deletions(-) create mode 100644 public/openapi/write/chats/roomId/messages.yaml diff --git a/public/openapi/write.yaml b/public/openapi/write.yaml index 25cd96fef7..2e1eb4f9e8 100644 --- a/public/openapi/write.yaml +++ b/public/openapi/write.yaml @@ -144,6 +144,8 @@ paths: $ref: 'write/chats/roomId/users.yaml' /chats/{roomId}/users/{uid}: $ref: 'write/chats/roomId/users/uid.yaml' + /chats/{roomId}/messages: + $ref: 'write/chats/roomId/messages.yaml' /chats/{roomId}/messages/{mid}: $ref: 'write/chats/roomId/messages/mid.yaml' /flags/: diff --git a/public/openapi/write/chats/roomId/messages.yaml b/public/openapi/write/chats/roomId/messages.yaml new file mode 100644 index 0000000000..ee981a871f --- /dev/null +++ b/public/openapi/write/chats/roomId/messages.yaml @@ -0,0 +1,54 @@ +get: + tags: + - chats + summary: get chat room messages + description: This operation retrieves the messages in a chat room, with pagination options accepted + parameters: + - in: path + name: roomId + schema: + type: number + required: true + description: a valid chat room id + example: 1 + - in: query + name: uid + schema: + type: number + description: a valid user id + example: 1 + - in: query + name: start + schema: + type: number + description: At which chat message index to start returning messages from + example: 0 + responses: + '200': + description: Messages successfully retrieved + content: + application/json: + schema: + type: object + properties: + status: + $ref: ../../../components/schemas/Status.yaml#/Status + response: + type: object + properties: + messages: + type: array + items: + allOf: + - $ref: ../../../components/schemas/Chats.yaml#/MessageObject + - type: object + description: Optional properties that may or may not be present (except for `messageId`, which is always present, and is only here as a hack to pass validation) + properties: + messageId: + type: number + index: + type: number + isOwner: + type: boolean + required: + - messageId \ No newline at end of file diff --git a/public/src/client/chats.js b/public/src/client/chats.js index e199ca4110..8796a89436 100644 --- a/public/src/client/chats.js +++ b/public/src/client/chats.js @@ -122,14 +122,9 @@ define('forum/chats', [ } loading = true; const start = parseInt(el.children('[data-mid]').length, 10); - socket.emit('modules.chats.getMessages', { - roomId: roomId, - uid: uid, - start: start, - }, function (err, data) { - if (err) { - return alerts.error(err); - } + api.get(`/chats/${roomId}/messages`, { uid, start }).then((data) => { + data = data.messages; + if (!data) { loading = false; return; @@ -151,7 +146,7 @@ define('forum/chats', [ el.scrollTop((el[0].scrollHeight - previousHeight) + currentScrollTop); loading = false; }); - }); + }).catch(alerts.error); }); }; diff --git a/src/controllers/write/chats.js b/src/controllers/write/chats.js index 999eccb220..f009047a61 100644 --- a/src/controllers/write/chats.js +++ b/src/controllers/write/chats.js @@ -89,6 +89,18 @@ Chats.kickUser = async (req, res) => { }; Chats.messages = {}; +Chats.messages.list = async (req, res) => { + const messages = await messaging.getMessages({ + callerUid: req.uid, + uid: req.query.uid || req.uid, + roomId: req.params.roomId, + start: parseInt(req.query.start, 10) || 0, + count: 50, + }); + + helpers.formatApiResponse(200, res, { messages }); +}; + Chats.messages.get = async (req, res) => { const messages = await messaging.getMessagesData([req.params.mid], req.uid, req.params.roomId, false); helpers.formatApiResponse(200, res, messages.pop()); diff --git a/src/routes/write/chats.js b/src/routes/write/chats.js index 7f9fd9eaee..1e5d870ca5 100644 --- a/src/routes/write/chats.js +++ b/src/routes/write/chats.js @@ -24,6 +24,7 @@ module.exports = function () { setupApiRoute(router, 'delete', '/:roomId/users', [...middlewares, middleware.assert.room, middleware.checkRequired.bind(null, ['uids'])], controllers.write.chats.kick); setupApiRoute(router, 'delete', '/:roomId/users/:uid', [...middlewares, middleware.assert.room, middleware.assert.user], controllers.write.chats.kickUser); + setupApiRoute(router, 'get', '/:roomId/messages', [...middlewares, middleware.assert.room], controllers.write.chats.messages.list); setupApiRoute(router, 'get', '/:roomId/messages/:mid', [...middlewares, middleware.assert.room, middleware.assert.message], controllers.write.chats.messages.get); setupApiRoute(router, 'put', '/:roomId/messages/:mid', [...middlewares, middleware.assert.room, middleware.assert.message], controllers.write.chats.messages.edit); setupApiRoute(router, 'post', '/:roomId/messages/:mid', [...middlewares, middleware.assert.room, middleware.assert.message], controllers.write.chats.messages.restore); diff --git a/src/socket.io/modules.js b/src/socket.io/modules.js index 4e9b31a225..a06765d681 100644 --- a/src/socket.io/modules.js +++ b/src/socket.io/modules.js @@ -232,6 +232,8 @@ SocketModules.chats.hasPrivateChat = async function (socket, uid) { }; SocketModules.chats.getMessages = async function (socket, data) { + sockets.warnDeprecated(socket, 'GET /api/v3/chats/:roomId/messages'); + if (!socket.uid || !data || !data.uid || !data.roomId) { throw new Error('[[error:invalid-data]]'); }