server/tests/api/live/live-constraints.ts

   1 /* eslint-disable @typescript-eslint/no-unused-expressions,@typescript-eslint/require-await */
   2
   3 import 'mocha'
   4 import * as chai from 'chai'
   5 import { wait } from '@shared/core-utils'
   6 import { LiveVideoError, VideoPrivacy } from '@shared/models'
   7 import {
   8   cleanupTests,
   9   ConfigCommand,
  10   createMultipleServers,
  11   doubleFollow,
  12   PeerTubeServer,
  13   setAccessTokensToServers,
  14   setDefaultVideoChannel,
  15   waitJobs,
  16   waitUntilLiveReplacedByReplayOnAllServers,
  17   waitUntilLiveWaitingOnAllServers
  18 } from '@shared/server-commands'
  19 import { checkLiveCleanup } from '../../shared'
  20
  21 const expect = chai.expect
  22
  23 describe('Test live constraints', function () {
  24   let servers: PeerTubeServer[] = []
  25   let userId: number
  26   let userAccessToken: string
  27   let userChannelId: number
  28
  29   async function createLiveWrapper (options: {
  30     replay: boolean
  31     permanent: boolean
  32   }) {
  33     const { replay, permanent } = options
  34
  35     const liveAttributes = {
  36       name: 'user live',
  37       channelId: userChannelId,
  38       privacy: VideoPrivacy.PUBLIC,
  39       saveReplay: replay,
  40       permanentLive: permanent
  41     }
  42
  43     const { uuid } = await servers[0].live.create({ token: userAccessToken, fields: liveAttributes })
  44     return uuid
  45   }
  46
  47   async function checkSaveReplay (videoId: string, resolutions = [ 720 ]) {
  48     for (const server of servers) {
  49       const video = await server.videos.get({ id: videoId })
  50       expect(video.isLive).to.be.false
  51       expect(video.duration).to.be.greaterThan(0)
  52     }
  53
  54     await checkLiveCleanup(servers[0], videoId, resolutions)
  55   }
  56
  57   function updateQuota (options: { total: number, daily: number }) {
  58     return servers[0].users.update({
  59       userId,
  60       videoQuota: options.total,
  61       videoQuotaDaily: options.daily
  62     })
  63   }
  64
  65   before(async function () {
  66     this.timeout(120000)
  67
  68     servers = await createMultipleServers(2)
  69
  70     // Get the access tokens
  71     await setAccessTokensToServers(servers)
  72     await setDefaultVideoChannel(servers)
  73
  74     await servers[0].config.updateCustomSubConfig({
  75       newConfig: {
  76         live: {
  77           enabled: true,
  78           allowReplay: true,
  79           transcoding: {
  80             enabled: false
  81           }
  82         }
  83       }
  84     })
  85
  86     {
  87       const res = await servers[0].users.generate('user1')
  88       userId = res.userId
  89       userChannelId = res.userChannelId
  90       userAccessToken = res.token
  91
  92       await updateQuota({ total: 1, daily: -1 })
  93     }
  94
  95     // Server 1 and server 2 follow each other
  96     await doubleFollow(servers[0], servers[1])
  97   })
  98
  99   it('Should not have size limit if save replay is disabled', async function () {
 100     this.timeout(60000)
 101
 102     const userVideoLiveoId = await createLiveWrapper({ replay: false, permanent: false })
 103     await servers[0].live.runAndTestStreamError({ token: userAccessToken, videoId: userVideoLiveoId, shouldHaveError: false })
 104   })
 105
 106   it('Should have size limit depending on user global quota if save replay is enabled on non permanent live', async function () {
 107     this.timeout(60000)
 108
 109     // Wait for user quota memoize cache invalidation
 110     await wait(5000)
 111
 112     const userVideoLiveoId = await createLiveWrapper({ replay: true, permanent: false })
 113     await servers[0].live.runAndTestStreamError({ token: userAccessToken, videoId: userVideoLiveoId, shouldHaveError: true })
 114
 115     await waitUntilLiveReplacedByReplayOnAllServers(servers, userVideoLiveoId)
 116     await waitJobs(servers)
 117
 118     await checkSaveReplay(userVideoLiveoId)
 119
 120     const session = await servers[0].live.getReplaySession({ videoId: userVideoLiveoId })
 121     expect(session.error).to.equal(LiveVideoError.QUOTA_EXCEEDED)
 122   })
 123
 124   it('Should have size limit depending on user global quota if save replay is enabled on a permanent live', async function () {
 125     this.timeout(60000)
 126
 127     // Wait for user quota memoize cache invalidation
 128     await wait(5000)
 129
 130     const userVideoLiveoId = await createLiveWrapper({ replay: true, permanent: true })
 131     await servers[0].live.runAndTestStreamError({ token: userAccessToken, videoId: userVideoLiveoId, shouldHaveError: true })
 132
 133     await waitJobs(servers)
 134     await waitUntilLiveWaitingOnAllServers(servers, userVideoLiveoId)
 135
 136     const session = await servers[0].live.findLatestSession({ videoId: userVideoLiveoId })
 137     expect(session.error).to.equal(LiveVideoError.QUOTA_EXCEEDED)
 138   })
 139
 140   it('Should have size limit depending on user daily quota if save replay is enabled', async function () {
 141     this.timeout(60000)
 142
 143     // Wait for user quota memoize cache invalidation
 144     await wait(5000)
 145
 146     await updateQuota({ total: -1, daily: 1 })
 147
 148     const userVideoLiveoId = await createLiveWrapper({ replay: true, permanent: false })
 149     await servers[0].live.runAndTestStreamError({ token: userAccessToken, videoId: userVideoLiveoId, shouldHaveError: true })
 150
 151     await waitUntilLiveReplacedByReplayOnAllServers(servers, userVideoLiveoId)
 152     await waitJobs(servers)
 153
 154     await checkSaveReplay(userVideoLiveoId)
 155
 156     const session = await servers[0].live.getReplaySession({ videoId: userVideoLiveoId })
 157     expect(session.error).to.equal(LiveVideoError.QUOTA_EXCEEDED)
 158   })
 159
 160   it('Should succeed without quota limit', async function () {
 161     this.timeout(60000)
 162
 163     // Wait for user quota memoize cache invalidation
 164     await wait(5000)
 165
 166     await updateQuota({ total: 10 * 1000 * 1000, daily: -1 })
 167
 168     const userVideoLiveoId = await createLiveWrapper({ replay: true, permanent: false })
 169     await servers[0].live.runAndTestStreamError({ token: userAccessToken, videoId: userVideoLiveoId, shouldHaveError: false })
 170   })
 171
 172   it('Should have max duration limit', async function () {
 173     this.timeout(60000)
 174
 175     await servers[0].config.updateCustomSubConfig({
 176       newConfig: {
 177         live: {
 178           enabled: true,
 179           allowReplay: true,
 180           maxDuration: 1,
 181           transcoding: {
 182             enabled: true,
 183             resolutions: ConfigCommand.getCustomConfigResolutions(true)
 184           }
 185         }
 186       }
 187     })
 188
 189     const userVideoLiveoId = await createLiveWrapper({ replay: true, permanent: false })
 190     await servers[0].live.runAndTestStreamError({ token: userAccessToken, videoId: userVideoLiveoId, shouldHaveError: true })
 191
 192     await waitUntilLiveReplacedByReplayOnAllServers(servers, userVideoLiveoId)
 193     await waitJobs(servers)
 194
 195     await checkSaveReplay(userVideoLiveoId, [ 720, 480, 360, 240, 144 ])
 196
 197     const session = await servers[0].live.getReplaySession({ videoId: userVideoLiveoId })
 198     expect(session.error).to.equal(LiveVideoError.DURATION_EXCEEDED)
 199   })
 200
 201   after(async function () {
 202     await cleanupTests(servers)
 203   })
 204 })