server/tests/api/videos/video-comments.ts

   1 /* eslint-disable @typescript-eslint/no-unused-expressions,@typescript-eslint/require-await */
   2
   3 import { expect } from 'chai'
   4 import { dateIsValid, testImage } from '@server/tests/shared'
   5 import {
   6   cleanupTests,
   7   CommentsCommand,
   8   createSingleServer,
   9   PeerTubeServer,
  10   setAccessTokensToServers,
  11   setDefaultAccountAvatar,
  12   setDefaultChannelAvatar
  13 } from '@shared/server-commands'
  14
  15 describe('Test video comments', function () {
  16   let server: PeerTubeServer
  17   let videoId: number
  18   let videoUUID: string
  19   let threadId: number
  20   let replyToDeleteId: number
  21
  22   let userAccessTokenServer1: string
  23
  24   let command: CommentsCommand
  25
  26   before(async function () {
  27     this.timeout(120000)
  28
  29     server = await createSingleServer(1)
  30
  31     await setAccessTokensToServers([ server ])
  32
  33     const { id, uuid } = await server.videos.upload()
  34     videoUUID = uuid
  35     videoId = id
  36
  37     await setDefaultChannelAvatar(server)
  38     await setDefaultAccountAvatar(server)
  39
  40     userAccessTokenServer1 = await server.users.generateUserAndToken('user1')
  41     await setDefaultChannelAvatar(server, 'user1_channel')
  42     await setDefaultAccountAvatar(server, userAccessTokenServer1)
  43
  44     command = server.comments
  45   })
  46
  47   describe('User comments', function () {
  48
  49     it('Should not have threads on this video', async function () {
  50       const body = await command.listThreads({ videoId: videoUUID })
  51
  52       expect(body.total).to.equal(0)
  53       expect(body.totalNotDeletedComments).to.equal(0)
  54       expect(body.data).to.be.an('array')
  55       expect(body.data).to.have.lengthOf(0)
  56     })
  57
  58     it('Should create a thread in this video', async function () {
  59       const text = 'my super first comment'
  60
  61       const comment = await command.createThread({ videoId: videoUUID, text })
  62
  63       expect(comment.inReplyToCommentId).to.be.null
  64       expect(comment.text).equal('my super first comment')
  65       expect(comment.videoId).to.equal(videoId)
  66       expect(comment.id).to.equal(comment.threadId)
  67       expect(comment.account.name).to.equal('root')
  68       expect(comment.account.host).to.equal(server.host)
  69       expect(comment.account.url).to.equal(server.url + '/accounts/root')
  70       expect(comment.totalReplies).to.equal(0)
  71       expect(comment.totalRepliesFromVideoAuthor).to.equal(0)
  72       expect(dateIsValid(comment.createdAt as string)).to.be.true
  73       expect(dateIsValid(comment.updatedAt as string)).to.be.true
  74     })
  75
  76     it('Should list threads of this video', async function () {
  77       const body = await command.listThreads({ videoId: videoUUID })
  78
  79       expect(body.total).to.equal(1)
  80       expect(body.totalNotDeletedComments).to.equal(1)
  81       expect(body.data).to.be.an('array')
  82       expect(body.data).to.have.lengthOf(1)
  83
  84       const comment = body.data[0]
  85       expect(comment.inReplyToCommentId).to.be.null
  86       expect(comment.text).equal('my super first comment')
  87       expect(comment.videoId).to.equal(videoId)
  88       expect(comment.id).to.equal(comment.threadId)
  89       expect(comment.account.name).to.equal('root')
  90       expect(comment.account.host).to.equal(server.host)
  91
  92       for (const avatar of comment.account.avatars) {
  93         await testImage(server.url, `avatar-resized-${avatar.width}x${avatar.width}`, avatar.path, '.png')
  94       }
  95
  96       expect(comment.totalReplies).to.equal(0)
  97       expect(comment.totalRepliesFromVideoAuthor).to.equal(0)
  98       expect(dateIsValid(comment.createdAt as string)).to.be.true
  99       expect(dateIsValid(comment.updatedAt as string)).to.be.true
 100
 101       threadId = comment.threadId
 102     })
 103
 104     it('Should get all the thread created', async function () {
 105       const body = await command.getThread({ videoId: videoUUID, threadId })
 106
 107       const rootComment = body.comment
 108       expect(rootComment.inReplyToCommentId).to.be.null
 109       expect(rootComment.text).equal('my super first comment')
 110       expect(rootComment.videoId).to.equal(videoId)
 111       expect(dateIsValid(rootComment.createdAt as string)).to.be.true
 112       expect(dateIsValid(rootComment.updatedAt as string)).to.be.true
 113     })
 114
 115     it('Should create multiple replies in this thread', async function () {
 116       const text1 = 'my super answer to thread 1'
 117       const created = await command.addReply({ videoId, toCommentId: threadId, text: text1 })
 118       const childCommentId = created.id
 119
 120       const text2 = 'my super answer to answer of thread 1'
 121       await command.addReply({ videoId, toCommentId: childCommentId, text: text2 })
 122
 123       const text3 = 'my second answer to thread 1'
 124       await command.addReply({ videoId, toCommentId: threadId, text: text3 })
 125     })
 126
 127     it('Should get correctly the replies', async function () {
 128       const tree = await command.getThread({ videoId: videoUUID, threadId })
 129
 130       expect(tree.comment.text).equal('my super first comment')
 131       expect(tree.children).to.have.lengthOf(2)
 132
 133       const firstChild = tree.children[0]
 134       expect(firstChild.comment.text).to.equal('my super answer to thread 1')
 135       expect(firstChild.children).to.have.lengthOf(1)
 136
 137       const childOfFirstChild = firstChild.children[0]
 138       expect(childOfFirstChild.comment.text).to.equal('my super answer to answer of thread 1')
 139       expect(childOfFirstChild.children).to.have.lengthOf(0)
 140
 141       const secondChild = tree.children[1]
 142       expect(secondChild.comment.text).to.equal('my second answer to thread 1')
 143       expect(secondChild.children).to.have.lengthOf(0)
 144
 145       replyToDeleteId = secondChild.comment.id
 146     })
 147
 148     it('Should create other threads', async function () {
 149       const text1 = 'super thread 2'
 150       await command.createThread({ videoId: videoUUID, text: text1 })
 151
 152       const text2 = 'super thread 3'
 153       await command.createThread({ videoId: videoUUID, text: text2 })
 154     })
 155
 156     it('Should list the threads', async function () {
 157       const body = await command.listThreads({ videoId: videoUUID, sort: 'createdAt' })
 158
 159       expect(body.total).to.equal(3)
 160       expect(body.totalNotDeletedComments).to.equal(6)
 161       expect(body.data).to.be.an('array')
 162       expect(body.data).to.have.lengthOf(3)
 163
 164       expect(body.data[0].text).to.equal('my super first comment')
 165       expect(body.data[0].totalReplies).to.equal(3)
 166       expect(body.data[1].text).to.equal('super thread 2')
 167       expect(body.data[1].totalReplies).to.equal(0)
 168       expect(body.data[2].text).to.equal('super thread 3')
 169       expect(body.data[2].totalReplies).to.equal(0)
 170     })
 171
 172     it('Should list the and sort them by total replies', async function () {
 173       const body = await command.listThreads({ videoId: videoUUID, sort: 'totalReplies' })
 174
 175       expect(body.data[2].text).to.equal('my super first comment')
 176       expect(body.data[2].totalReplies).to.equal(3)
 177     })
 178
 179     it('Should delete a reply', async function () {
 180       await command.delete({ videoId, commentId: replyToDeleteId })
 181
 182       {
 183         const body = await command.listThreads({ videoId: videoUUID, sort: 'createdAt' })
 184
 185         expect(body.total).to.equal(3)
 186         expect(body.totalNotDeletedComments).to.equal(5)
 187       }
 188
 189       {
 190         const tree = await command.getThread({ videoId: videoUUID, threadId })
 191
 192         expect(tree.comment.text).equal('my super first comment')
 193         expect(tree.children).to.have.lengthOf(2)
 194
 195         const firstChild = tree.children[0]
 196         expect(firstChild.comment.text).to.equal('my super answer to thread 1')
 197         expect(firstChild.children).to.have.lengthOf(1)
 198
 199         const childOfFirstChild = firstChild.children[0]
 200         expect(childOfFirstChild.comment.text).to.equal('my super answer to answer of thread 1')
 201         expect(childOfFirstChild.children).to.have.lengthOf(0)
 202
 203         const deletedChildOfFirstChild = tree.children[1]
 204         expect(deletedChildOfFirstChild.comment.text).to.equal('')
 205         expect(deletedChildOfFirstChild.comment.isDeleted).to.be.true
 206         expect(deletedChildOfFirstChild.comment.deletedAt).to.not.be.null
 207         expect(deletedChildOfFirstChild.comment.account).to.be.null
 208         expect(deletedChildOfFirstChild.children).to.have.lengthOf(0)
 209       }
 210     })
 211
 212     it('Should delete a complete thread', async function () {
 213       await command.delete({ videoId, commentId: threadId })
 214
 215       const body = await command.listThreads({ videoId: videoUUID, sort: 'createdAt' })
 216       expect(body.total).to.equal(3)
 217       expect(body.data).to.be.an('array')
 218       expect(body.data).to.have.lengthOf(3)
 219
 220       expect(body.data[0].text).to.equal('')
 221       expect(body.data[0].isDeleted).to.be.true
 222       expect(body.data[0].deletedAt).to.not.be.null
 223       expect(body.data[0].account).to.be.null
 224       expect(body.data[0].totalReplies).to.equal(2)
 225       expect(body.data[1].text).to.equal('super thread 2')
 226       expect(body.data[1].totalReplies).to.equal(0)
 227       expect(body.data[2].text).to.equal('super thread 3')
 228       expect(body.data[2].totalReplies).to.equal(0)
 229     })
 230
 231     it('Should count replies from the video author correctly', async function () {
 232       await command.createThread({ videoId: videoUUID, text: 'my super first comment' })
 233
 234       const { data } = await command.listThreads({ videoId: videoUUID })
 235       const threadId2 = data[0].threadId
 236
 237       const text2 = 'a first answer to thread 4 by a third party'
 238       await command.addReply({ token: userAccessTokenServer1, videoId, toCommentId: threadId2, text: text2 })
 239
 240       const text3 = 'my second answer to thread 4'
 241       await command.addReply({ videoId, toCommentId: threadId2, text: text3 })
 242
 243       const tree = await command.getThread({ videoId: videoUUID, threadId: threadId2 })
 244       expect(tree.comment.totalRepliesFromVideoAuthor).to.equal(1)
 245       expect(tree.comment.totalReplies).to.equal(2)
 246     })
 247   })
 248
 249   describe('All instance comments', function () {
 250
 251     it('Should list instance comments as admin', async function () {
 252       {
 253         const { data, total } = await command.listForAdmin({ start: 0, count: 1 })
 254
 255         expect(total).to.equal(7)
 256         expect(data).to.have.lengthOf(1)
 257         expect(data[0].text).to.equal('my second answer to thread 4')
 258         expect(data[0].account.name).to.equal('root')
 259         expect(data[0].account.displayName).to.equal('root')
 260         expect(data[0].account.avatars).to.have.lengthOf(2)
 261       }
 262
 263       {
 264         const { data, total } = await command.listForAdmin({ start: 1, count: 2 })
 265
 266         expect(total).to.equal(7)
 267         expect(data).to.have.lengthOf(2)
 268
 269         expect(data[0].account.avatars).to.have.lengthOf(2)
 270         expect(data[1].account.avatars).to.have.lengthOf(2)
 271       }
 272     })
 273
 274     it('Should filter instance comments by isLocal', async function () {
 275       const { total, data } = await command.listForAdmin({ isLocal: false })
 276
 277       expect(data).to.have.lengthOf(0)
 278       expect(total).to.equal(0)
 279     })
 280
 281     it('Should filter instance comments by onLocalVideo', async function () {
 282       {
 283         const { total, data } = await command.listForAdmin({ onLocalVideo: false })
 284
 285         expect(data).to.have.lengthOf(0)
 286         expect(total).to.equal(0)
 287       }
 288
 289       {
 290         const { total, data } = await command.listForAdmin({ onLocalVideo: true })
 291
 292         expect(data).to.not.have.lengthOf(0)
 293         expect(total).to.not.equal(0)
 294       }
 295     })
 296
 297     it('Should search instance comments by account', async function () {
 298       const { total, data } = await command.listForAdmin({ searchAccount: 'user' })
 299
 300       expect(data).to.have.lengthOf(1)
 301       expect(total).to.equal(1)
 302
 303       expect(data[0].text).to.equal('a first answer to thread 4 by a third party')
 304     })
 305
 306     it('Should search instance comments by video', async function () {
 307       {
 308         const { total, data } = await command.listForAdmin({ searchVideo: 'video' })
 309
 310         expect(data).to.have.lengthOf(7)
 311         expect(total).to.equal(7)
 312       }
 313
 314       {
 315         const { total, data } = await command.listForAdmin({ searchVideo: 'hello' })
 316
 317         expect(data).to.have.lengthOf(0)
 318         expect(total).to.equal(0)
 319       }
 320     })
 321
 322     it('Should search instance comments', async function () {
 323       const { total, data } = await command.listForAdmin({ search: 'super thread 3' })
 324
 325       expect(total).to.equal(1)
 326
 327       expect(data).to.have.lengthOf(1)
 328       expect(data[0].text).to.equal('super thread 3')
 329     })
 330   })
 331
 332   after(async function () {
 333     await cleanupTests([ server ])
 334   })
 335 })