server/tests/api/notifications/user-notifications.ts

   1 /* eslint-disable @typescript-eslint/no-unused-expressions,@typescript-eslint/require-await */
   2
   3 import * as chai from 'chai'
   4 import {
   5   CheckerBaseParams,
   6   checkMyVideoImportIsFinished,
   7   checkNewActorFollow,
   8   checkNewVideoFromSubscription,
   9   checkVideoIsPublished,
  10   checkVideoStudioEditionIsFinished,
  11   FIXTURE_URLS,
  12   MockSmtpServer,
  13   prepareNotificationsTest,
  14   uploadRandomVideoOnServers
  15 } from '@server/tests/shared'
  16 import { wait } from '@shared/core-utils'
  17 import { buildUUID } from '@shared/extra-utils'
  18 import { UserNotification, UserNotificationType, VideoPrivacy, VideoStudioTask } from '@shared/models'
  19 import { cleanupTests, findExternalSavedVideo, PeerTubeServer, stopFfmpeg, waitJobs } from '@shared/server-commands'
  20
  21 const expect = chai.expect
  22
  23 describe('Test user notifications', function () {
  24   let servers: PeerTubeServer[] = []
  25   let userAccessToken: string
  26
  27   let userNotifications: UserNotification[] = []
  28   let adminNotifications: UserNotification[] = []
  29   let adminNotificationsServer2: UserNotification[] = []
  30   let emails: object[] = []
  31
  32   let channelId: number
  33
  34   before(async function () {
  35     this.timeout(120000)
  36
  37     const res = await prepareNotificationsTest(3)
  38     emails = res.emails
  39     userAccessToken = res.userAccessToken
  40     servers = res.servers
  41     userNotifications = res.userNotifications
  42     adminNotifications = res.adminNotifications
  43     adminNotificationsServer2 = res.adminNotificationsServer2
  44     channelId = res.channelId
  45   })
  46
  47   describe('New video from my subscription notification', function () {
  48     let baseParams: CheckerBaseParams
  49
  50     before(() => {
  51       baseParams = {
  52         server: servers[0],
  53         emails,
  54         socketNotifications: userNotifications,
  55         token: userAccessToken
  56       }
  57     })
  58
  59     it('Should not send notifications if the user does not follow the video publisher', async function () {
  60       this.timeout(50000)
  61
  62       await uploadRandomVideoOnServers(servers, 1)
  63
  64       const notification = await servers[0].notifications.getLatest({ token: userAccessToken })
  65       expect(notification).to.be.undefined
  66
  67       expect(emails).to.have.lengthOf(0)
  68       expect(userNotifications).to.have.lengthOf(0)
  69     })
  70
  71     it('Should send a new video notification if the user follows the local video publisher', async function () {
  72       this.timeout(15000)
  73
  74       await servers[0].subscriptions.add({ token: userAccessToken, targetUri: 'root_channel@localhost:' + servers[0].port })
  75       await waitJobs(servers)
  76
  77       const { name, shortUUID } = await uploadRandomVideoOnServers(servers, 1)
  78       await checkNewVideoFromSubscription({ ...baseParams, videoName: name, shortUUID, checkType: 'presence' })
  79     })
  80
  81     it('Should send a new video notification from a remote account', async function () {
  82       this.timeout(150000) // Server 2 has transcoding enabled
  83
  84       await servers[0].subscriptions.add({ token: userAccessToken, targetUri: 'root_channel@localhost:' + servers[1].port })
  85       await waitJobs(servers)
  86
  87       const { name, shortUUID } = await uploadRandomVideoOnServers(servers, 2)
  88       await checkNewVideoFromSubscription({ ...baseParams, videoName: name, shortUUID, checkType: 'presence' })
  89     })
  90
  91     it('Should send a new video notification on a scheduled publication', async function () {
  92       this.timeout(50000)
  93
  94       // In 2 seconds
  95       const updateAt = new Date(new Date().getTime() + 2000)
  96
  97       const data = {
  98         privacy: VideoPrivacy.PRIVATE,
  99         scheduleUpdate: {
 100           updateAt: updateAt.toISOString(),
 101           privacy: VideoPrivacy.PUBLIC as VideoPrivacy.PUBLIC
 102         }
 103       }
 104       const { name, shortUUID } = await uploadRandomVideoOnServers(servers, 1, data)
 105
 106       await wait(6000)
 107       await checkNewVideoFromSubscription({ ...baseParams, videoName: name, shortUUID, checkType: 'presence' })
 108     })
 109
 110     it('Should send a new video notification on a remote scheduled publication', async function () {
 111       this.timeout(100000)
 112
 113       // In 2 seconds
 114       const updateAt = new Date(new Date().getTime() + 2000)
 115
 116       const data = {
 117         privacy: VideoPrivacy.PRIVATE,
 118         scheduleUpdate: {
 119           updateAt: updateAt.toISOString(),
 120           privacy: VideoPrivacy.PUBLIC as VideoPrivacy.PUBLIC
 121         }
 122       }
 123       const { name, shortUUID } = await uploadRandomVideoOnServers(servers, 2, data)
 124       await waitJobs(servers)
 125
 126       await wait(6000)
 127       await checkNewVideoFromSubscription({ ...baseParams, videoName: name, shortUUID, checkType: 'presence' })
 128     })
 129
 130     it('Should not send a notification before the video is published', async function () {
 131       this.timeout(150000)
 132
 133       const updateAt = new Date(new Date().getTime() + 1000000)
 134
 135       const data = {
 136         privacy: VideoPrivacy.PRIVATE,
 137         scheduleUpdate: {
 138           updateAt: updateAt.toISOString(),
 139           privacy: VideoPrivacy.PUBLIC as VideoPrivacy.PUBLIC
 140         }
 141       }
 142       const { name, shortUUID } = await uploadRandomVideoOnServers(servers, 1, data)
 143
 144       await wait(6000)
 145       await checkNewVideoFromSubscription({ ...baseParams, videoName: name, shortUUID, checkType: 'absence' })
 146     })
 147
 148     it('Should send a new video notification when a video becomes public', async function () {
 149       this.timeout(50000)
 150
 151       const data = { privacy: VideoPrivacy.PRIVATE }
 152       const { name, uuid, shortUUID } = await uploadRandomVideoOnServers(servers, 1, data)
 153
 154       await checkNewVideoFromSubscription({ ...baseParams, videoName: name, shortUUID, checkType: 'absence' })
 155
 156       await servers[0].videos.update({ id: uuid, attributes: { privacy: VideoPrivacy.PUBLIC } })
 157
 158       await waitJobs(servers)
 159       await checkNewVideoFromSubscription({ ...baseParams, videoName: name, shortUUID, checkType: 'presence' })
 160     })
 161
 162     it('Should send a new video notification when a remote video becomes public', async function () {
 163       this.timeout(50000)
 164
 165       const data = { privacy: VideoPrivacy.PRIVATE }
 166       const { name, uuid, shortUUID } = await uploadRandomVideoOnServers(servers, 2, data)
 167
 168       await checkNewVideoFromSubscription({ ...baseParams, videoName: name, shortUUID, checkType: 'absence' })
 169
 170       await servers[1].videos.update({ id: uuid, attributes: { privacy: VideoPrivacy.PUBLIC } })
 171
 172       await waitJobs(servers)
 173       await checkNewVideoFromSubscription({ ...baseParams, videoName: name, shortUUID, checkType: 'presence' })
 174     })
 175
 176     it('Should not send a new video notification when a video becomes unlisted', async function () {
 177       this.timeout(50000)
 178
 179       const data = { privacy: VideoPrivacy.PRIVATE }
 180       const { name, uuid, shortUUID } = await uploadRandomVideoOnServers(servers, 1, data)
 181
 182       await servers[0].videos.update({ id: uuid, attributes: { privacy: VideoPrivacy.UNLISTED } })
 183
 184       await checkNewVideoFromSubscription({ ...baseParams, videoName: name, shortUUID, checkType: 'absence' })
 185     })
 186
 187     it('Should not send a new video notification when a remote video becomes unlisted', async function () {
 188       this.timeout(100000)
 189
 190       const data = { privacy: VideoPrivacy.PRIVATE }
 191       const { name, uuid, shortUUID } = await uploadRandomVideoOnServers(servers, 2, data)
 192
 193       await servers[1].videos.update({ id: uuid, attributes: { privacy: VideoPrivacy.UNLISTED } })
 194
 195       await waitJobs(servers)
 196       await checkNewVideoFromSubscription({ ...baseParams, videoName: name, shortUUID, checkType: 'absence' })
 197     })
 198
 199     it('Should send a new video notification after a video import', async function () {
 200       this.timeout(100000)
 201
 202       const name = 'video import ' + buildUUID()
 203
 204       const attributes = {
 205         name,
 206         channelId,
 207         privacy: VideoPrivacy.PUBLIC,
 208         targetUrl: FIXTURE_URLS.goodVideo
 209       }
 210       const { video } = await servers[0].imports.importVideo({ attributes })
 211
 212       await waitJobs(servers)
 213
 214       await checkNewVideoFromSubscription({ ...baseParams, videoName: name, shortUUID: video.shortUUID, checkType: 'presence' })
 215     })
 216   })
 217
 218   describe('My video is published', function () {
 219     let baseParams: CheckerBaseParams
 220
 221     before(() => {
 222       baseParams = {
 223         server: servers[1],
 224         emails,
 225         socketNotifications: adminNotificationsServer2,
 226         token: servers[1].accessToken
 227       }
 228     })
 229
 230     it('Should not send a notification if transcoding is not enabled', async function () {
 231       this.timeout(50000)
 232
 233       const { name, shortUUID } = await uploadRandomVideoOnServers(servers, 1)
 234       await waitJobs(servers)
 235
 236       await checkVideoIsPublished({ ...baseParams, videoName: name, shortUUID, checkType: 'absence' })
 237     })
 238
 239     it('Should not send a notification if the wait transcoding is false', async function () {
 240       this.timeout(100_000)
 241
 242       await uploadRandomVideoOnServers(servers, 2, { waitTranscoding: false })
 243       await waitJobs(servers)
 244
 245       const notification = await servers[0].notifications.getLatest({ token: userAccessToken })
 246       if (notification) {
 247         expect(notification.type).to.not.equal(UserNotificationType.MY_VIDEO_PUBLISHED)
 248       }
 249     })
 250
 251     it('Should send a notification even if the video is not transcoded in other resolutions', async function () {
 252       this.timeout(50000)
 253
 254       const { name, shortUUID } = await uploadRandomVideoOnServers(servers, 2, { waitTranscoding: true, fixture: 'video_short_240p.mp4' })
 255       await waitJobs(servers)
 256
 257       await checkVideoIsPublished({ ...baseParams, videoName: name, shortUUID, checkType: 'presence' })
 258     })
 259
 260     it('Should send a notification with a transcoded video', async function () {
 261       this.timeout(50000)
 262
 263       const { name, shortUUID } = await uploadRandomVideoOnServers(servers, 2, { waitTranscoding: true })
 264       await waitJobs(servers)
 265
 266       await checkVideoIsPublished({ ...baseParams, videoName: name, shortUUID, checkType: 'presence' })
 267     })
 268
 269     it('Should send a notification when an imported video is transcoded', async function () {
 270       this.timeout(120000)
 271
 272       const name = 'video import ' + buildUUID()
 273
 274       const attributes = {
 275         name,
 276         channelId,
 277         privacy: VideoPrivacy.PUBLIC,
 278         targetUrl: FIXTURE_URLS.goodVideo,
 279         waitTranscoding: true
 280       }
 281       const { video } = await servers[1].imports.importVideo({ attributes })
 282
 283       await waitJobs(servers)
 284       await checkVideoIsPublished({ ...baseParams, videoName: name, shortUUID: video.shortUUID, checkType: 'presence' })
 285     })
 286
 287     it('Should send a notification when the scheduled update has been proceeded', async function () {
 288       this.timeout(70000)
 289
 290       // In 2 seconds
 291       const updateAt = new Date(new Date().getTime() + 2000)
 292
 293       const data = {
 294         privacy: VideoPrivacy.PRIVATE,
 295         scheduleUpdate: {
 296           updateAt: updateAt.toISOString(),
 297           privacy: VideoPrivacy.PUBLIC as VideoPrivacy.PUBLIC
 298         }
 299       }
 300       const { name, shortUUID } = await uploadRandomVideoOnServers(servers, 2, data)
 301
 302       await wait(6000)
 303       await checkVideoIsPublished({ ...baseParams, videoName: name, shortUUID, checkType: 'presence' })
 304     })
 305
 306     it('Should not send a notification before the video is published', async function () {
 307       this.timeout(50000)
 308
 309       const updateAt = new Date(new Date().getTime() + 1000000)
 310
 311       const data = {
 312         privacy: VideoPrivacy.PRIVATE,
 313         scheduleUpdate: {
 314           updateAt: updateAt.toISOString(),
 315           privacy: VideoPrivacy.PUBLIC as VideoPrivacy.PUBLIC
 316         }
 317       }
 318       const { name, shortUUID } = await uploadRandomVideoOnServers(servers, 2, data)
 319
 320       await wait(6000)
 321       await checkVideoIsPublished({ ...baseParams, videoName: name, shortUUID, checkType: 'absence' })
 322     })
 323   })
 324
 325   describe('My live replay is published', function () {
 326
 327     let baseParams: CheckerBaseParams
 328
 329     before(() => {
 330       baseParams = {
 331         server: servers[1],
 332         emails,
 333         socketNotifications: adminNotificationsServer2,
 334         token: servers[1].accessToken
 335       }
 336     })
 337
 338     it('Should send a notification is a live replay of a non permanent live is published', async function () {
 339       this.timeout(120000)
 340
 341       const { shortUUID } = await servers[1].live.create({
 342         fields: {
 343           name: 'non permanent live',
 344           privacy: VideoPrivacy.PUBLIC,
 345           channelId: servers[1].store.channel.id,
 346           saveReplay: true,
 347           permanentLive: false
 348         }
 349       })
 350
 351       const ffmpegCommand = await servers[1].live.sendRTMPStreamInVideo({ videoId: shortUUID })
 352
 353       await waitJobs(servers)
 354       await servers[1].live.waitUntilPublished({ videoId: shortUUID })
 355
 356       await stopFfmpeg(ffmpegCommand)
 357       await servers[1].live.waitUntilReplacedByReplay({ videoId: shortUUID })
 358
 359       await waitJobs(servers)
 360       await checkVideoIsPublished({ ...baseParams, videoName: 'non permanent live', shortUUID, checkType: 'presence' })
 361     })
 362
 363     it('Should send a notification is a live replay of a permanent live is published', async function () {
 364       this.timeout(120000)
 365
 366       const { shortUUID } = await servers[1].live.create({
 367         fields: {
 368           name: 'permanent live',
 369           privacy: VideoPrivacy.PUBLIC,
 370           channelId: servers[1].store.channel.id,
 371           saveReplay: true,
 372           permanentLive: true
 373         }
 374       })
 375
 376       const ffmpegCommand = await servers[1].live.sendRTMPStreamInVideo({ videoId: shortUUID })
 377
 378       await waitJobs(servers)
 379       await servers[1].live.waitUntilPublished({ videoId: shortUUID })
 380
 381       const liveDetails = await servers[1].videos.get({ id: shortUUID })
 382
 383       await stopFfmpeg(ffmpegCommand)
 384
 385       await servers[1].live.waitUntilWaiting({ videoId: shortUUID })
 386       await waitJobs(servers)
 387
 388       const video = await findExternalSavedVideo(servers[1], liveDetails)
 389       expect(video).to.exist
 390
 391       await checkVideoIsPublished({ ...baseParams, videoName: video.name, shortUUID: video.shortUUID, checkType: 'presence' })
 392     })
 393   })
 394
 395   describe('Video studio', function () {
 396     let baseParams: CheckerBaseParams
 397
 398     before(() => {
 399       baseParams = {
 400         server: servers[1],
 401         emails,
 402         socketNotifications: adminNotificationsServer2,
 403         token: servers[1].accessToken
 404       }
 405     })
 406
 407     it('Should send a notification after studio edition', async function () {
 408       this.timeout(240000)
 409
 410       const { name, shortUUID, id } = await uploadRandomVideoOnServers(servers, 2, { waitTranscoding: true })
 411
 412       await waitJobs(servers)
 413       await checkVideoIsPublished({ ...baseParams, videoName: name, shortUUID, checkType: 'presence' })
 414
 415       const tasks: VideoStudioTask[] = [
 416         {
 417           name: 'cut',
 418           options: {
 419             start: 0,
 420             end: 1
 421           }
 422         }
 423       ]
 424       await servers[1].videoStudio.createEditionTasks({ videoId: id, tasks })
 425       await waitJobs(servers)
 426
 427       await checkVideoStudioEditionIsFinished({ ...baseParams, videoName: name, shortUUID, checkType: 'presence' })
 428     })
 429   })
 430
 431   describe('My video is imported', function () {
 432     let baseParams: CheckerBaseParams
 433
 434     before(() => {
 435       baseParams = {
 436         server: servers[0],
 437         emails,
 438         socketNotifications: adminNotifications,
 439         token: servers[0].accessToken
 440       }
 441     })
 442
 443     it('Should send a notification when the video import failed', async function () {
 444       this.timeout(70000)
 445
 446       const name = 'video import ' + buildUUID()
 447
 448       const attributes = {
 449         name,
 450         channelId,
 451         privacy: VideoPrivacy.PRIVATE,
 452         targetUrl: FIXTURE_URLS.badVideo
 453       }
 454       const { video: { shortUUID } } = await servers[0].imports.importVideo({ attributes })
 455
 456       await waitJobs(servers)
 457
 458       const url = FIXTURE_URLS.badVideo
 459       await checkMyVideoImportIsFinished({ ...baseParams, videoName: name, shortUUID, url, success: false, checkType: 'presence' })
 460     })
 461
 462     it('Should send a notification when the video import succeeded', async function () {
 463       this.timeout(70000)
 464
 465       const name = 'video import ' + buildUUID()
 466
 467       const attributes = {
 468         name,
 469         channelId,
 470         privacy: VideoPrivacy.PRIVATE,
 471         targetUrl: FIXTURE_URLS.goodVideo
 472       }
 473       const { video: { shortUUID } } = await servers[0].imports.importVideo({ attributes })
 474
 475       await waitJobs(servers)
 476
 477       const url = FIXTURE_URLS.goodVideo
 478       await checkMyVideoImportIsFinished({ ...baseParams, videoName: name, shortUUID, url, success: true, checkType: 'presence' })
 479     })
 480   })
 481
 482   describe('New actor follow', function () {
 483     let baseParams: CheckerBaseParams
 484     const myChannelName = 'super channel name'
 485     const myUserName = 'super user name'
 486
 487     before(async () => {
 488       baseParams = {
 489         server: servers[0],
 490         emails,
 491         socketNotifications: userNotifications,
 492         token: userAccessToken
 493       }
 494
 495       await servers[0].users.updateMe({ displayName: 'super root name' })
 496
 497       await servers[0].users.updateMe({
 498         token: userAccessToken,
 499         displayName: myUserName
 500       })
 501
 502       await servers[1].users.updateMe({ displayName: 'super root 2 name' })
 503
 504       await servers[0].channels.update({
 505         token: userAccessToken,
 506         channelName: 'user_1_channel',
 507         attributes: { displayName: myChannelName }
 508       })
 509     })
 510
 511     it('Should notify when a local channel is following one of our channel', async function () {
 512       this.timeout(50000)
 513
 514       await servers[0].subscriptions.add({ targetUri: 'user_1_channel@localhost:' + servers[0].port })
 515       await waitJobs(servers)
 516
 517       await checkNewActorFollow({
 518         ...baseParams,
 519         followType: 'channel',
 520         followerName: 'root',
 521         followerDisplayName: 'super root name',
 522         followingDisplayName: myChannelName,
 523         checkType: 'presence'
 524       })
 525
 526       await servers[0].subscriptions.remove({ uri: 'user_1_channel@localhost:' + servers[0].port })
 527     })
 528
 529     it('Should notify when a remote channel is following one of our channel', async function () {
 530       this.timeout(50000)
 531
 532       await servers[1].subscriptions.add({ targetUri: 'user_1_channel@localhost:' + servers[0].port })
 533       await waitJobs(servers)
 534
 535       await checkNewActorFollow({
 536         ...baseParams,
 537         followType: 'channel',
 538         followerName: 'root',
 539         followerDisplayName: 'super root 2 name',
 540         followingDisplayName: myChannelName,
 541         checkType: 'presence'
 542       })
 543
 544       await servers[1].subscriptions.remove({ uri: 'user_1_channel@localhost:' + servers[0].port })
 545     })
 546
 547     // PeerTube does not support account -> account follows
 548     // it('Should notify when a local account is following one of our channel', async function () {
 549     //   this.timeout(50000)
 550     //
 551     //   await addUserSubscription(servers[0].url, servers[0].accessToken, 'user_1@localhost:' + servers[0].port)
 552     //
 553     //   await waitJobs(servers)
 554     //
 555     //   await checkNewActorFollow(baseParams, 'account', 'root', 'super root name', myUserName, 'presence')
 556     // })
 557
 558     // it('Should notify when a remote account is following one of our channel', async function () {
 559     //   this.timeout(50000)
 560     //
 561     //   await addUserSubscription(servers[1].url, servers[1].accessToken, 'user_1@localhost:' + servers[0].port)
 562     //
 563     //   await waitJobs(servers)
 564     //
 565     //   await checkNewActorFollow(baseParams, 'account', 'root', 'super root 2 name', myUserName, 'presence')
 566     // })
 567   })
 568
 569   after(async function () {
 570     MockSmtpServer.Instance.kill()
 571
 572     await cleanupTests(servers)
 573   })
 574 })