MessageHttpController.js 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456
  1. import logger from '@overleaf/logger'
  2. import * as MessageManager from './MessageManager.js'
  3. import * as MessageFormatter from './MessageFormatter.js'
  4. import * as ThreadManager from '../Threads/ThreadManager.js'
  5. import { ObjectId } from '../../mongodb.js'
  6. import { promiseMapWithLimit } from '@overleaf/promise-utils'
  7. const DEFAULT_MESSAGE_LIMIT = 50
  8. const MAX_MESSAGE_LENGTH = 10 * 1024 // 10kb, about 1,500 words
  9. function readContext(context, req) {
  10. req.body = context.requestBody
  11. req.params = context.params.path
  12. req.query = context.params.query
  13. if (typeof req.params.projectId !== 'undefined') {
  14. if (!ObjectId.isValid(req.params.projectId)) {
  15. context.res.status(400).setBody('Invalid projectId')
  16. }
  17. }
  18. if (typeof req.params.threadId !== 'undefined') {
  19. if (!ObjectId.isValid(req.params.threadId)) {
  20. context.res.status(400).setBody('Invalid threadId')
  21. }
  22. }
  23. }
  24. /**
  25. * @param context
  26. * @param {(req: unknown, res: unknown) => Promise<unknown>} ControllerMethod
  27. * @returns {Promise<*>}
  28. */
  29. export async function callMessageHttpController(context, ControllerMethod) {
  30. const req = {}
  31. readContext(context, req)
  32. if (context.res.statusCode !== 400) {
  33. return await ControllerMethod(req, context.res)
  34. } else {
  35. return context.res.body
  36. }
  37. }
  38. export async function getGlobalMessages(context) {
  39. return await callMessageHttpController(context, _getGlobalMessages)
  40. }
  41. export async function getGlobalMessage(context) {
  42. return await callMessageHttpController(context, _getGlobalMessage)
  43. }
  44. export async function sendGlobalMessage(context) {
  45. return await callMessageHttpController(context, _sendGlobalMessage)
  46. }
  47. export async function sendMessage(context) {
  48. return await callMessageHttpController(context, _sendThreadMessage)
  49. }
  50. export async function getThreads(context) {
  51. return await callMessageHttpController(context, _getAllThreads)
  52. }
  53. export async function getThread(context) {
  54. return await callMessageHttpController(context, _getThread)
  55. }
  56. export async function getThreadMessage(context) {
  57. return await callMessageHttpController(context, _getThreadMessage)
  58. }
  59. export async function resolveThread(context) {
  60. return await callMessageHttpController(context, _resolveThread)
  61. }
  62. export async function reopenThread(context) {
  63. return await callMessageHttpController(context, _reopenThread)
  64. }
  65. export async function deleteThread(context) {
  66. return await callMessageHttpController(context, _deleteThread)
  67. }
  68. export async function editMessage(context) {
  69. return await callMessageHttpController(context, _editMessage)
  70. }
  71. export async function editGlobalMessage(context) {
  72. return await callMessageHttpController(context, _editGlobalMessage)
  73. }
  74. export async function deleteMessage(context) {
  75. return await callMessageHttpController(context, _deleteMessage)
  76. }
  77. export async function deleteUserMessage(context) {
  78. return await callMessageHttpController(context, _deleteUserMessage)
  79. }
  80. export async function deleteGlobalMessage(context) {
  81. return await callMessageHttpController(context, _deleteGlobalMessage)
  82. }
  83. export async function getResolvedThreadIds(context) {
  84. return await callMessageHttpController(context, _getResolvedThreadIds)
  85. }
  86. export async function destroyProject(context) {
  87. return await callMessageHttpController(context, _destroyProject)
  88. }
  89. export async function duplicateCommentThreads(context) {
  90. return await callMessageHttpController(context, _duplicateCommentThreads)
  91. }
  92. export async function generateThreadData(context) {
  93. return await callMessageHttpController(context, _generateThreadData)
  94. }
  95. export async function cloneCommentThreads(context) {
  96. return await callMessageHttpController(context, _cloneCommentThreads)
  97. }
  98. export async function getStatus(context) {
  99. const message = 'chat is alive'
  100. context.res.status(200).setBody(message)
  101. return message
  102. }
  103. const _getGlobalMessages = async (req, res) => {
  104. await _getMessages(ThreadManager.GLOBAL_THREAD, req, res)
  105. }
  106. const _getGlobalMessage = async (req, res) => {
  107. const { projectId, messageId } = req.params
  108. logger.debug({ projectId, messageId }, 'getting single global message')
  109. try {
  110. const room = await ThreadManager.findThread(
  111. projectId,
  112. ThreadManager.GLOBAL_THREAD
  113. )
  114. const message = await MessageManager.getMessage(room._id, messageId)
  115. const formattedMsg = MessageFormatter.formatMessageForClientSide(message)
  116. res.status(200).setBody(formattedMsg)
  117. } catch (error) {
  118. if (
  119. error instanceof ThreadManager.MissingThreadError ||
  120. error instanceof MessageManager.MissingMessageError
  121. ) {
  122. res.status(404)
  123. return
  124. }
  125. throw error
  126. }
  127. }
  128. async function _sendGlobalMessage(req, res) {
  129. const { user_id: userId, content } = req.body
  130. const { projectId } = req.params
  131. return await _sendMessage(
  132. userId,
  133. projectId,
  134. content,
  135. ThreadManager.GLOBAL_THREAD,
  136. res
  137. )
  138. }
  139. async function _sendThreadMessage(req, res) {
  140. const { user_id: userId, content } = req.body
  141. const { projectId, threadId } = req.params
  142. return await _sendMessage(userId, projectId, content, threadId, res)
  143. }
  144. const _getAllThreads = async (req, res) => {
  145. const { projectId } = req.params
  146. logger.debug({ projectId }, 'getting all threads')
  147. const rooms = await ThreadManager.findAllThreadRooms(projectId)
  148. const roomIds = rooms.map(r => r._id)
  149. const messages = await MessageManager.findAllMessagesInRooms(roomIds)
  150. const threads = MessageFormatter.groupMessagesByThreads(rooms, messages)
  151. res.json(threads)
  152. }
  153. const _generateThreadData = async (req, res) => {
  154. const { projectId } = req.params
  155. const { threads } = req.body
  156. logger.debug({ projectId }, 'getting all threads')
  157. const rooms = await ThreadManager.findThreadsById(projectId, threads)
  158. const roomIds = rooms.map(r => r._id)
  159. const messages = await MessageManager.findAllMessagesInRooms(roomIds)
  160. logger.debug({ rooms, messages }, 'looked up messages in the rooms')
  161. const threadData = MessageFormatter.groupMessagesByThreads(rooms, messages)
  162. res.json(threadData)
  163. }
  164. const _getThread = async (req, res) => {
  165. const { projectId, threadId } = req.params
  166. logger.debug({ projectId, threadId }, 'getting specific thread')
  167. try {
  168. const room = await ThreadManager.findThread(projectId, threadId)
  169. const messages = await MessageManager.findAllMessagesInRooms([room._id])
  170. const threads = MessageFormatter.groupMessagesByThreads([room], messages)
  171. const thread = threads[threadId] || null
  172. if (!thread) {
  173. res.status(404)
  174. return
  175. }
  176. res.json(thread)
  177. } catch (error) {
  178. if (error instanceof ThreadManager.MissingThreadError) {
  179. res.status(404)
  180. return
  181. }
  182. throw error
  183. }
  184. }
  185. const _getThreadMessage = async (req, res) => {
  186. const { projectId, threadId, messageId } = req.params
  187. logger.debug(
  188. { projectId, threadId, messageId },
  189. 'getting single thread message'
  190. )
  191. try {
  192. const room = await ThreadManager.findThread(projectId, threadId)
  193. const message = await MessageManager.getMessage(room._id, messageId)
  194. const formattedMsg = MessageFormatter.formatMessageForClientSide(message)
  195. res.status(200).setBody(formattedMsg)
  196. } catch (error) {
  197. if (
  198. error instanceof ThreadManager.MissingThreadError ||
  199. error instanceof MessageManager.MissingMessageError
  200. ) {
  201. res.status(404)
  202. return
  203. }
  204. throw error
  205. }
  206. }
  207. const _resolveThread = async (req, res) => {
  208. const { projectId, threadId } = req.params
  209. const { user_id: userId } = req.body
  210. logger.debug({ userId, projectId, threadId }, 'marking thread as resolved')
  211. await ThreadManager.resolveThread(projectId, threadId, userId)
  212. res.status(204)
  213. }
  214. const _reopenThread = async (req, res) => {
  215. const { projectId, threadId } = req.params
  216. logger.debug({ projectId, threadId }, 'reopening thread')
  217. await ThreadManager.reopenThread(projectId, threadId)
  218. res.status(204)
  219. }
  220. const _deleteThread = async (req, res) => {
  221. const { projectId, threadId } = req.params
  222. logger.debug({ projectId, threadId }, 'deleting thread')
  223. const roomId = await ThreadManager.deleteThread(projectId, threadId)
  224. await MessageManager.deleteAllMessagesInRoom(roomId)
  225. res.status(204)
  226. }
  227. const _editMessage = async (req, res) => {
  228. const { content, userId } = req.body
  229. const { projectId, threadId, messageId } = req.params
  230. logger.debug({ projectId, threadId, messageId, content }, 'editing message')
  231. const room = await ThreadManager.findOrCreateThread(projectId, threadId)
  232. const found = await MessageManager.updateMessage(
  233. room._id,
  234. messageId,
  235. userId,
  236. content,
  237. Date.now()
  238. )
  239. if (!found) {
  240. res.status(404)
  241. return
  242. }
  243. res.status(204)
  244. }
  245. const _editGlobalMessage = async (req, res) => {
  246. const { content, userId } = req.body
  247. const { projectId, messageId } = req.params
  248. logger.debug({ projectId, messageId, content }, 'editing global message')
  249. const room = await ThreadManager.findOrCreateThread(
  250. projectId,
  251. ThreadManager.GLOBAL_THREAD
  252. )
  253. const found = await MessageManager.updateMessage(
  254. room._id,
  255. messageId,
  256. userId,
  257. content,
  258. Date.now()
  259. )
  260. if (!found) {
  261. res.status(404)
  262. return
  263. }
  264. res.status(204)
  265. }
  266. const _deleteMessage = async (req, res) => {
  267. const { projectId, threadId, messageId } = req.params
  268. logger.debug({ projectId, threadId, messageId }, 'deleting message')
  269. const room = await ThreadManager.findOrCreateThread(projectId, threadId)
  270. await MessageManager.deleteMessage(room._id, messageId)
  271. res.status(204)
  272. }
  273. const _deleteUserMessage = async (req, res) => {
  274. const { projectId, threadId, userId, messageId } = req.params
  275. const room = await ThreadManager.findOrCreateThread(projectId, threadId)
  276. await MessageManager.deleteUserMessage(userId, room._id, messageId)
  277. res.status(204)
  278. }
  279. const _deleteGlobalMessage = async (req, res) => {
  280. const { projectId, messageId } = req.params
  281. const room = await ThreadManager.findOrCreateThread(
  282. projectId,
  283. ThreadManager.GLOBAL_THREAD
  284. )
  285. await MessageManager.deleteMessage(room._id, messageId)
  286. res.status(204)
  287. }
  288. const _getResolvedThreadIds = async (req, res) => {
  289. const { projectId } = req.params
  290. const resolvedThreadIds = await ThreadManager.getResolvedThreadIds(projectId)
  291. res.json({ resolvedThreadIds })
  292. }
  293. const _destroyProject = async (req, res) => {
  294. const { projectId } = req.params
  295. logger.debug({ projectId }, 'destroying project')
  296. const rooms = await ThreadManager.findAllThreadRoomsAndGlobalThread(projectId)
  297. const roomIds = rooms.map(r => r._id)
  298. logger.debug({ projectId, roomIds }, 'deleting all messages in rooms')
  299. await MessageManager.deleteAllMessagesInRooms(roomIds)
  300. logger.debug({ projectId }, 'deleting all threads in project')
  301. await ThreadManager.deleteAllThreadsInProject(projectId)
  302. res.status(204)
  303. }
  304. async function _sendMessage(userId, projectId, content, clientThreadId, res) {
  305. if (!ObjectId.isValid(userId)) {
  306. const message = 'Invalid userId'
  307. res.status(400).setBody(message)
  308. return message
  309. }
  310. if (!content) {
  311. const message = 'No content provided'
  312. res.status(400).setBody(message)
  313. return message
  314. }
  315. if (content.length > MAX_MESSAGE_LENGTH) {
  316. const message = `Content too long (> ${MAX_MESSAGE_LENGTH} bytes)`
  317. res.status(400).setBody(message)
  318. return message
  319. }
  320. logger.debug(
  321. { clientThreadId, projectId, userId, content },
  322. 'new message received'
  323. )
  324. const thread = await ThreadManager.findOrCreateThread(
  325. projectId,
  326. clientThreadId
  327. )
  328. let message = await MessageManager.createMessage(
  329. thread._id,
  330. userId,
  331. content,
  332. Date.now()
  333. )
  334. message = MessageFormatter.formatMessageForClientSide(message)
  335. message.room_id = projectId
  336. res.status(201).setBody(message)
  337. }
  338. async function _getMessages(clientThreadId, req, res) {
  339. let before, limit
  340. const { projectId } = req.params
  341. if (req.query.before) {
  342. before = parseInt(req.query.before, 10)
  343. } else {
  344. before = null
  345. }
  346. if (req.query.limit) {
  347. limit = parseInt(req.query.limit, 10)
  348. } else {
  349. limit = DEFAULT_MESSAGE_LIMIT
  350. }
  351. logger.debug(
  352. { limit, before, projectId, clientThreadId },
  353. 'get message request received'
  354. )
  355. const thread = await ThreadManager.findOrCreateThread(
  356. projectId,
  357. clientThreadId
  358. )
  359. const threadObjectId = thread._id
  360. logger.debug(
  361. { limit, before, projectId, clientThreadId, threadObjectId },
  362. 'found or created thread'
  363. )
  364. let messages = await MessageManager.getMessages(threadObjectId, limit, before)
  365. messages = MessageFormatter.formatMessagesForClientSide(messages)
  366. logger.debug({ projectId, messages }, 'got messages')
  367. res.status(200).setBody(messages)
  368. }
  369. async function _duplicateCommentThreads(req, res) {
  370. const { projectId } = req.params
  371. const { threads } = req.body
  372. const result = {}
  373. for (const id of threads) {
  374. logger.debug({ projectId, thread: id }, 'duplicating thread')
  375. try {
  376. const { oldRoom, newRoom } = await ThreadManager.duplicateThread(
  377. projectId,
  378. id
  379. )
  380. await MessageManager.duplicateRoomToOtherRoom(oldRoom._id, newRoom._id)
  381. result[id] = { duplicateId: newRoom.thread_id }
  382. } catch (error) {
  383. if (error instanceof ThreadManager.MissingThreadError) {
  384. // Expected error when the comment has been deleted prior to duplication
  385. result[id] = { error: 'not found' }
  386. } else {
  387. logger.err({ error }, 'error duplicating thread')
  388. result[id] = { error: 'unknown' }
  389. }
  390. }
  391. }
  392. res.json({ newThreads: result })
  393. }
  394. async function _cloneCommentThreads(req, res) {
  395. const { projectId: sourceProjectId } = req.params
  396. const { targetProjectId } = req.body
  397. const rooms = await ThreadManager.cloneThreads(
  398. sourceProjectId,
  399. targetProjectId
  400. )
  401. await promiseMapWithLimit(10, rooms, async ({ from, to }) => {
  402. await MessageManager.duplicateRoomToOtherRoom(from, to)
  403. })
  404. res.status(204)
  405. }