Files
habitica/website/server/controllers/api-v4/inbox.js
negue 5630e8cc8e Performance: Inbox Paging / loading (#11157)
* load messages per conversation

* only sort ones in ui

*  add contributor to message

* fix correct message layout/message

* mugenScroll on chatMessages

* fix lint, no mugen-scroll, use own scroll handler

* fix height / margin of modal + use button to load more

* fix tests

* user data from inbox

* style "load earlier messages"

*  move mapMessage to the inbox api result / extract sentMessage of members-api-controller

* fix test back

* fix test

* keep last scroll position

* just set the Id of the returned message instead of all other properties

* fix add new messages (buttons were hidden) + load more

* item-mounted debounce to trigger the re-scrolling
2019-06-13 15:18:50 +02:00

142 lines
3.7 KiB
JavaScript

import { authWithHeaders } from '../../middlewares/auth';
import apiError from '../../libs/apiError';
import * as inboxLib from '../../libs/inbox';
import {
NotFound,
} from '../../libs/errors';
const api = {};
/* NOTE most inbox routes are either in the user or members controller */
/* NOTE the getInboxMessages route is implemented in v3 only */
/* NOTE this route has also an API v3 version */
/**
* @api {delete} /api/v4/inbox/messages/:messageId Delete a message
* @apiName deleteMessage
* @apiGroup User
*
* @apiParam (Path) {UUID} messageId The id of the message to delete
*
* @apiSuccess {Object} data Empty object
* @apiSuccessExample {json}
* {
* "success": true,
* "data": {}
* }
*/
api.deleteMessage = {
method: 'DELETE',
middlewares: [authWithHeaders()],
url: '/inbox/messages/:messageId',
async handler (req, res) {
req.checkParams('messageId', apiError('messageIdRequired')).notEmpty().isUUID();
const validationErrors = req.validationErrors();
if (validationErrors) throw validationErrors;
const messageId = req.params.messageId;
const user = res.locals.user;
const deleted = await inboxLib.deleteMessage(user, messageId);
if (!deleted) throw new NotFound(res.t('messageGroupChatNotFound'));
res.respond(200);
},
};
/* NOTE this route has also an API v3 version */
/**
* @api {delete} /api/v4/inbox/clear Delete all messages
* @apiName clearMessages
* @apiGroup User
*
* @apiSuccess {Object} data Empty object
*
* @apiSuccessExample {json}
* {"success":true,"data":{},"notifications":[]}
*/
api.clearMessages = {
method: 'DELETE',
middlewares: [authWithHeaders()],
url: '/inbox/clear',
async handler (req, res) {
const user = res.locals.user;
await inboxLib.clearPMs(user);
res.respond(200, {});
},
};
/**
* @api {get} /api/v4/inbox/conversations Get the conversations for a user
* @apiName conversations
* @apiGroup Inbox
* @apiDescription Get the conversations for a user
*
* @apiSuccess {Array} data An array of inbox conversations
*/
api.conversations = {
method: 'GET',
middlewares: [authWithHeaders()],
url: '/inbox/conversations',
async handler (req, res) {
const user = res.locals.user;
const result = await inboxLib.listConversations(user);
res.respond(200, result);
},
};
function mapMessage (newChat, user) {
if (newChat.sent) {
newChat.toUUID = newChat.uuid;
newChat.toUser = newChat.user;
newChat.toUserName = newChat.username;
newChat.toUserContributor = newChat.contributor;
newChat.toUserBacker = newChat.backer;
newChat.uuid = user._id;
newChat.user = user.profile.name;
newChat.username = user.auth.local.username;
newChat.contributor = user.contributor;
newChat.backer = user.backer;
}
return newChat;
}
/**
* @api {get} /api/v4/inbox/messages Get inbox messages for a user
* @apiName GetInboxMessages
* @apiGroup Inbox
* @apiDescription Get inbox messages for a user. Entries already populated with the correct `sent` - information
*
* @apiParam (Query) {Number} page Load the messages of the selected Page - 10 Messages per Page
* @apiParam (Query) {GUID} conversation Loads only the messages of a conversation
*
* @apiSuccess {Array} data An array of inbox messages
*/
api.getInboxMessages = {
method: 'GET',
url: '/inbox/messages',
middlewares: [authWithHeaders()],
async handler (req, res) {
const user = res.locals.user;
const page = req.query.page;
const conversation = req.query.conversation;
const userInbox = (await inboxLib.getUserInbox(user, {
page, conversation,
})).map(newChat => mapMessage(newChat, user));
res.respond(200, userInbox);
},
};
module.exports = api;