server/tests/api/server/config.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 {
   6   cleanupTests,
   7   createSingleServer,
   8   killallServers,
   9   makeGetRequest,
  10   parallelTests,
  11   PeerTubeServer,
  12   setAccessTokensToServers
  13 } from '@shared/extra-utils'
  14 import { CustomConfig, HttpStatusCode } from '@shared/models'
  15
  16 const expect = chai.expect
  17
  18 function checkInitialConfig (server: PeerTubeServer, data: CustomConfig) {
  19   expect(data.instance.name).to.equal('PeerTube')
  20   expect(data.instance.shortDescription).to.equal(
  21     'PeerTube, an ActivityPub-federated video streaming platform using P2P directly in your web browser.'
  22   )
  23   expect(data.instance.description).to.equal('Welcome to this PeerTube instance!')
  24
  25   expect(data.instance.terms).to.equal('No terms for now.')
  26   expect(data.instance.creationReason).to.be.empty
  27   expect(data.instance.codeOfConduct).to.be.empty
  28   expect(data.instance.moderationInformation).to.be.empty
  29   expect(data.instance.administrator).to.be.empty
  30   expect(data.instance.maintenanceLifetime).to.be.empty
  31   expect(data.instance.businessModel).to.be.empty
  32   expect(data.instance.hardwareInformation).to.be.empty
  33
  34   expect(data.instance.languages).to.have.lengthOf(0)
  35   expect(data.instance.categories).to.have.lengthOf(0)
  36
  37   expect(data.instance.defaultClientRoute).to.equal('/videos/trending')
  38   expect(data.instance.isNSFW).to.be.false
  39   expect(data.instance.defaultNSFWPolicy).to.equal('display')
  40   expect(data.instance.customizations.css).to.be.empty
  41   expect(data.instance.customizations.javascript).to.be.empty
  42
  43   expect(data.services.twitter.username).to.equal('@Chocobozzz')
  44   expect(data.services.twitter.whitelisted).to.be.false
  45
  46   expect(data.cache.previews.size).to.equal(1)
  47   expect(data.cache.captions.size).to.equal(1)
  48   expect(data.cache.torrents.size).to.equal(1)
  49
  50   expect(data.signup.enabled).to.be.true
  51   expect(data.signup.limit).to.equal(4)
  52   expect(data.signup.minimumAge).to.equal(16)
  53   expect(data.signup.requiresEmailVerification).to.be.false
  54
  55   expect(data.admin.email).to.equal('admin' + server.internalServerNumber + '@example.com')
  56   expect(data.contactForm.enabled).to.be.true
  57
  58   expect(data.user.videoQuota).to.equal(5242880)
  59   expect(data.user.videoQuotaDaily).to.equal(-1)
  60
  61   expect(data.videoChannels.maxPerUser).to.equal(20)
  62
  63   expect(data.transcoding.enabled).to.be.false
  64   expect(data.transcoding.allowAdditionalExtensions).to.be.false
  65   expect(data.transcoding.allowAudioFiles).to.be.false
  66   expect(data.transcoding.threads).to.equal(2)
  67   expect(data.transcoding.concurrency).to.equal(2)
  68   expect(data.transcoding.profile).to.equal('default')
  69   expect(data.transcoding.resolutions['240p']).to.be.true
  70   expect(data.transcoding.resolutions['360p']).to.be.true
  71   expect(data.transcoding.resolutions['480p']).to.be.true
  72   expect(data.transcoding.resolutions['720p']).to.be.true
  73   expect(data.transcoding.resolutions['1080p']).to.be.true
  74   expect(data.transcoding.resolutions['1440p']).to.be.true
  75   expect(data.transcoding.resolutions['2160p']).to.be.true
  76   expect(data.transcoding.webtorrent.enabled).to.be.true
  77   expect(data.transcoding.hls.enabled).to.be.true
  78
  79   expect(data.live.enabled).to.be.false
  80   expect(data.live.allowReplay).to.be.false
  81   expect(data.live.maxDuration).to.equal(-1)
  82   expect(data.live.maxInstanceLives).to.equal(20)
  83   expect(data.live.maxUserLives).to.equal(3)
  84   expect(data.live.transcoding.enabled).to.be.false
  85   expect(data.live.transcoding.threads).to.equal(2)
  86   expect(data.live.transcoding.profile).to.equal('default')
  87   expect(data.live.transcoding.resolutions['240p']).to.be.false
  88   expect(data.live.transcoding.resolutions['360p']).to.be.false
  89   expect(data.live.transcoding.resolutions['480p']).to.be.false
  90   expect(data.live.transcoding.resolutions['720p']).to.be.false
  91   expect(data.live.transcoding.resolutions['1080p']).to.be.false
  92   expect(data.live.transcoding.resolutions['1440p']).to.be.false
  93   expect(data.live.transcoding.resolutions['2160p']).to.be.false
  94
  95   expect(data.import.videos.concurrency).to.equal(2)
  96   expect(data.import.videos.http.enabled).to.be.true
  97   expect(data.import.videos.torrent.enabled).to.be.true
  98   expect(data.autoBlacklist.videos.ofUsers.enabled).to.be.false
  99
 100   expect(data.followers.instance.enabled).to.be.true
 101   expect(data.followers.instance.manualApproval).to.be.false
 102
 103   expect(data.followings.instance.autoFollowBack.enabled).to.be.false
 104   expect(data.followings.instance.autoFollowIndex.enabled).to.be.false
 105   expect(data.followings.instance.autoFollowIndex.indexUrl).to.equal('')
 106
 107   expect(data.broadcastMessage.enabled).to.be.false
 108   expect(data.broadcastMessage.level).to.equal('info')
 109   expect(data.broadcastMessage.message).to.equal('')
 110   expect(data.broadcastMessage.dismissable).to.be.false
 111 }
 112
 113 function checkUpdatedConfig (data: CustomConfig) {
 114   expect(data.instance.name).to.equal('PeerTube updated')
 115   expect(data.instance.shortDescription).to.equal('my short description')
 116   expect(data.instance.description).to.equal('my super description')
 117
 118   expect(data.instance.terms).to.equal('my super terms')
 119   expect(data.instance.creationReason).to.equal('my super creation reason')
 120   expect(data.instance.codeOfConduct).to.equal('my super coc')
 121   expect(data.instance.moderationInformation).to.equal('my super moderation information')
 122   expect(data.instance.administrator).to.equal('Kuja')
 123   expect(data.instance.maintenanceLifetime).to.equal('forever')
 124   expect(data.instance.businessModel).to.equal('my super business model')
 125   expect(data.instance.hardwareInformation).to.equal('2vCore 3GB RAM')
 126
 127   expect(data.instance.languages).to.deep.equal([ 'en', 'es' ])
 128   expect(data.instance.categories).to.deep.equal([ 1, 2 ])
 129
 130   expect(data.instance.defaultClientRoute).to.equal('/videos/recently-added')
 131   expect(data.instance.isNSFW).to.be.true
 132   expect(data.instance.defaultNSFWPolicy).to.equal('blur')
 133   expect(data.instance.customizations.javascript).to.equal('alert("coucou")')
 134   expect(data.instance.customizations.css).to.equal('body { background-color: red; }')
 135
 136   expect(data.services.twitter.username).to.equal('@Kuja')
 137   expect(data.services.twitter.whitelisted).to.be.true
 138
 139   expect(data.cache.previews.size).to.equal(2)
 140   expect(data.cache.captions.size).to.equal(3)
 141   expect(data.cache.torrents.size).to.equal(4)
 142
 143   expect(data.signup.enabled).to.be.false
 144   expect(data.signup.limit).to.equal(5)
 145   expect(data.signup.requiresEmailVerification).to.be.false
 146   expect(data.signup.minimumAge).to.equal(10)
 147
 148   // We override admin email in parallel tests, so skip this exception
 149   if (parallelTests() === false) {
 150     expect(data.admin.email).to.equal('superadmin1@example.com')
 151   }
 152
 153   expect(data.contactForm.enabled).to.be.false
 154
 155   expect(data.user.videoQuota).to.equal(5242881)
 156   expect(data.user.videoQuotaDaily).to.equal(318742)
 157
 158   expect(data.videoChannels.maxPerUser).to.equal(24)
 159
 160   expect(data.transcoding.enabled).to.be.true
 161   expect(data.transcoding.threads).to.equal(1)
 162   expect(data.transcoding.concurrency).to.equal(3)
 163   expect(data.transcoding.allowAdditionalExtensions).to.be.true
 164   expect(data.transcoding.allowAudioFiles).to.be.true
 165   expect(data.transcoding.profile).to.equal('vod_profile')
 166   expect(data.transcoding.resolutions['240p']).to.be.false
 167   expect(data.transcoding.resolutions['360p']).to.be.true
 168   expect(data.transcoding.resolutions['480p']).to.be.true
 169   expect(data.transcoding.resolutions['720p']).to.be.false
 170   expect(data.transcoding.resolutions['1080p']).to.be.false
 171   expect(data.transcoding.resolutions['2160p']).to.be.false
 172   expect(data.transcoding.hls.enabled).to.be.false
 173   expect(data.transcoding.webtorrent.enabled).to.be.true
 174
 175   expect(data.live.enabled).to.be.true
 176   expect(data.live.allowReplay).to.be.true
 177   expect(data.live.maxDuration).to.equal(5000)
 178   expect(data.live.maxInstanceLives).to.equal(-1)
 179   expect(data.live.maxUserLives).to.equal(10)
 180   expect(data.live.transcoding.enabled).to.be.true
 181   expect(data.live.transcoding.threads).to.equal(4)
 182   expect(data.live.transcoding.profile).to.equal('live_profile')
 183   expect(data.live.transcoding.resolutions['240p']).to.be.true
 184   expect(data.live.transcoding.resolutions['360p']).to.be.true
 185   expect(data.live.transcoding.resolutions['480p']).to.be.true
 186   expect(data.live.transcoding.resolutions['720p']).to.be.true
 187   expect(data.live.transcoding.resolutions['1080p']).to.be.true
 188   expect(data.live.transcoding.resolutions['2160p']).to.be.true
 189
 190   expect(data.import.videos.concurrency).to.equal(4)
 191   expect(data.import.videos.http.enabled).to.be.false
 192   expect(data.import.videos.torrent.enabled).to.be.false
 193   expect(data.autoBlacklist.videos.ofUsers.enabled).to.be.true
 194
 195   expect(data.followers.instance.enabled).to.be.false
 196   expect(data.followers.instance.manualApproval).to.be.true
 197
 198   expect(data.followings.instance.autoFollowBack.enabled).to.be.true
 199   expect(data.followings.instance.autoFollowIndex.enabled).to.be.true
 200   expect(data.followings.instance.autoFollowIndex.indexUrl).to.equal('https://updated.example.com')
 201
 202   expect(data.broadcastMessage.enabled).to.be.true
 203   expect(data.broadcastMessage.level).to.equal('error')
 204   expect(data.broadcastMessage.message).to.equal('super bad message')
 205   expect(data.broadcastMessage.dismissable).to.be.true
 206 }
 207
 208 const newCustomConfig: CustomConfig = {
 209   instance: {
 210     name: 'PeerTube updated',
 211     shortDescription: 'my short description',
 212     description: 'my super description',
 213     terms: 'my super terms',
 214     codeOfConduct: 'my super coc',
 215
 216     creationReason: 'my super creation reason',
 217     moderationInformation: 'my super moderation information',
 218     administrator: 'Kuja',
 219     maintenanceLifetime: 'forever',
 220     businessModel: 'my super business model',
 221     hardwareInformation: '2vCore 3GB RAM',
 222
 223     languages: [ 'en', 'es' ],
 224     categories: [ 1, 2 ],
 225
 226     isNSFW: true,
 227     defaultNSFWPolicy: 'blur' as 'blur',
 228
 229     defaultClientRoute: '/videos/recently-added',
 230
 231     customizations: {
 232       javascript: 'alert("coucou")',
 233       css: 'body { background-color: red; }'
 234     }
 235   },
 236   theme: {
 237     default: 'default'
 238   },
 239   services: {
 240     twitter: {
 241       username: '@Kuja',
 242       whitelisted: true
 243     }
 244   },
 245   cache: {
 246     previews: {
 247       size: 2
 248     },
 249     captions: {
 250       size: 3
 251     },
 252     torrents: {
 253       size: 4
 254     }
 255   },
 256   signup: {
 257     enabled: false,
 258     limit: 5,
 259     requiresEmailVerification: false,
 260     minimumAge: 10
 261   },
 262   admin: {
 263     email: 'superadmin1@example.com'
 264   },
 265   contactForm: {
 266     enabled: false
 267   },
 268   user: {
 269     videoQuota: 5242881,
 270     videoQuotaDaily: 318742
 271   },
 272   videoChannels: {
 273     maxPerUser: 24
 274   },
 275   transcoding: {
 276     enabled: true,
 277     allowAdditionalExtensions: true,
 278     allowAudioFiles: true,
 279     threads: 1,
 280     concurrency: 3,
 281     profile: 'vod_profile',
 282     resolutions: {
 283       '0p': false,
 284       '240p': false,
 285       '360p': true,
 286       '480p': true,
 287       '720p': false,
 288       '1080p': false,
 289       '1440p': false,
 290       '2160p': false
 291     },
 292     webtorrent: {
 293       enabled: true
 294     },
 295     hls: {
 296       enabled: false
 297     }
 298   },
 299   live: {
 300     enabled: true,
 301     allowReplay: true,
 302     maxDuration: 5000,
 303     maxInstanceLives: -1,
 304     maxUserLives: 10,
 305     transcoding: {
 306       enabled: true,
 307       threads: 4,
 308       profile: 'live_profile',
 309       resolutions: {
 310         '240p': true,
 311         '360p': true,
 312         '480p': true,
 313         '720p': true,
 314         '1080p': true,
 315         '1440p': true,
 316         '2160p': true
 317       }
 318     }
 319   },
 320   import: {
 321     videos: {
 322       concurrency: 4,
 323       http: {
 324         enabled: false
 325       },
 326       torrent: {
 327         enabled: false
 328       }
 329     }
 330   },
 331   trending: {
 332     videos: {
 333       algorithms: {
 334         enabled: [ 'best', 'hot', 'most-viewed', 'most-liked' ],
 335         default: 'hot'
 336       }
 337     }
 338   },
 339   autoBlacklist: {
 340     videos: {
 341       ofUsers: {
 342         enabled: true
 343       }
 344     }
 345   },
 346   followers: {
 347     instance: {
 348       enabled: false,
 349       manualApproval: true
 350     }
 351   },
 352   followings: {
 353     instance: {
 354       autoFollowBack: {
 355         enabled: true
 356       },
 357       autoFollowIndex: {
 358         enabled: true,
 359         indexUrl: 'https://updated.example.com'
 360       }
 361     }
 362   },
 363   broadcastMessage: {
 364     enabled: true,
 365     level: 'error',
 366     message: 'super bad message',
 367     dismissable: true
 368   },
 369   search: {
 370     remoteUri: {
 371       anonymous: true,
 372       users: true
 373     },
 374     searchIndex: {
 375       enabled: true,
 376       url: 'https://search.joinpeertube.org',
 377       disableLocalSearch: true,
 378       isDefaultSearch: true
 379     }
 380   }
 381 }
 382
 383 describe('Test static config', function () {
 384   let server: PeerTubeServer = null
 385
 386   before(async function () {
 387     this.timeout(30000)
 388
 389     server = await createSingleServer(1, { webadmin: { configuration: { edition: { allowed: false } } } })
 390     await setAccessTokensToServers([ server ])
 391   })
 392
 393   it('Should tell the client that edits are not allowed', async function () {
 394     const data = await server.config.getConfig()
 395
 396     expect(data.webadmin.configuration.edition.allowed).to.be.false
 397   })
 398
 399   it('Should error when client tries to update', async function () {
 400     await server.config.updateCustomConfig({ newCustomConfig, expectedStatus: 405 })
 401   })
 402
 403   after(async function () {
 404     await cleanupTests([ server ])
 405   })
 406 })
 407
 408 describe('Test config', function () {
 409   let server: PeerTubeServer = null
 410
 411   before(async function () {
 412     this.timeout(30000)
 413
 414     server = await createSingleServer(1)
 415     await setAccessTokensToServers([ server ])
 416   })
 417
 418   it('Should have a correct config on a server with registration enabled', async function () {
 419     const data = await server.config.getConfig()
 420
 421     expect(data.signup.allowed).to.be.true
 422   })
 423
 424   it('Should have a correct config on a server with registration enabled and a users limit', async function () {
 425     this.timeout(5000)
 426
 427     await Promise.all([
 428       server.users.register({ username: 'user1' }),
 429       server.users.register({ username: 'user2' }),
 430       server.users.register({ username: 'user3' })
 431     ])
 432
 433     const data = await server.config.getConfig()
 434
 435     expect(data.signup.allowed).to.be.false
 436   })
 437
 438   it('Should have the correct video allowed extensions', async function () {
 439     const data = await server.config.getConfig()
 440
 441     expect(data.video.file.extensions).to.have.lengthOf(3)
 442     expect(data.video.file.extensions).to.contain('.mp4')
 443     expect(data.video.file.extensions).to.contain('.webm')
 444     expect(data.video.file.extensions).to.contain('.ogv')
 445
 446     await server.videos.upload({ attributes: { fixture: 'video_short.mkv' }, expectedStatus: HttpStatusCode.UNSUPPORTED_MEDIA_TYPE_415 })
 447     await server.videos.upload({ attributes: { fixture: 'sample.ogg' }, expectedStatus: HttpStatusCode.UNSUPPORTED_MEDIA_TYPE_415 })
 448
 449     expect(data.contactForm.enabled).to.be.true
 450   })
 451
 452   it('Should get the customized configuration', async function () {
 453     const data = await server.config.getCustomConfig()
 454
 455     checkInitialConfig(server, data)
 456   })
 457
 458   it('Should update the customized configuration', async function () {
 459     await server.config.updateCustomConfig({ newCustomConfig })
 460
 461     const data = await server.config.getCustomConfig()
 462     checkUpdatedConfig(data)
 463   })
 464
 465   it('Should have the correct updated video allowed extensions', async function () {
 466     this.timeout(10000)
 467
 468     const data = await server.config.getConfig()
 469
 470     expect(data.video.file.extensions).to.have.length.above(4)
 471     expect(data.video.file.extensions).to.contain('.mp4')
 472     expect(data.video.file.extensions).to.contain('.webm')
 473     expect(data.video.file.extensions).to.contain('.ogv')
 474     expect(data.video.file.extensions).to.contain('.flv')
 475     expect(data.video.file.extensions).to.contain('.wmv')
 476     expect(data.video.file.extensions).to.contain('.mkv')
 477     expect(data.video.file.extensions).to.contain('.mp3')
 478     expect(data.video.file.extensions).to.contain('.ogg')
 479     expect(data.video.file.extensions).to.contain('.flac')
 480
 481     await server.videos.upload({ attributes: { fixture: 'video_short.mkv' }, expectedStatus: HttpStatusCode.OK_200 })
 482     await server.videos.upload({ attributes: { fixture: 'sample.ogg' }, expectedStatus: HttpStatusCode.OK_200 })
 483   })
 484
 485   it('Should have the configuration updated after a restart', async function () {
 486     this.timeout(30000)
 487
 488     await killallServers([ server ])
 489
 490     await server.run()
 491
 492     const data = await server.config.getCustomConfig()
 493
 494     checkUpdatedConfig(data)
 495   })
 496
 497   it('Should fetch the about information', async function () {
 498     const data = await server.config.getAbout()
 499
 500     expect(data.instance.name).to.equal('PeerTube updated')
 501     expect(data.instance.shortDescription).to.equal('my short description')
 502     expect(data.instance.description).to.equal('my super description')
 503     expect(data.instance.terms).to.equal('my super terms')
 504     expect(data.instance.codeOfConduct).to.equal('my super coc')
 505
 506     expect(data.instance.creationReason).to.equal('my super creation reason')
 507     expect(data.instance.moderationInformation).to.equal('my super moderation information')
 508     expect(data.instance.administrator).to.equal('Kuja')
 509     expect(data.instance.maintenanceLifetime).to.equal('forever')
 510     expect(data.instance.businessModel).to.equal('my super business model')
 511     expect(data.instance.hardwareInformation).to.equal('2vCore 3GB RAM')
 512
 513     expect(data.instance.languages).to.deep.equal([ 'en', 'es' ])
 514     expect(data.instance.categories).to.deep.equal([ 1, 2 ])
 515   })
 516
 517   it('Should remove the custom configuration', async function () {
 518     this.timeout(10000)
 519
 520     await server.config.deleteCustomConfig()
 521
 522     const data = await server.config.getCustomConfig()
 523     checkInitialConfig(server, data)
 524   })
 525
 526   it('Should enable frameguard', async function () {
 527     this.timeout(25000)
 528
 529     {
 530       const res = await makeGetRequest({
 531         url: server.url,
 532         path: '/api/v1/config',
 533         expectedStatus: 200
 534       })
 535
 536       expect(res.headers['x-frame-options']).to.exist
 537     }
 538
 539     await killallServers([ server ])
 540
 541     const config = {
 542       security: {
 543         frameguard: { enabled: false }
 544       }
 545     }
 546     await server.run(config)
 547
 548     {
 549       const res = await makeGetRequest({
 550         url: server.url,
 551         path: '/api/v1/config',
 552         expectedStatus: 200
 553       })
 554
 555       expect(res.headers['x-frame-options']).to.not.exist
 556     }
 557   })
 558
 559   after(async function () {
 560     await cleanupTests([ server ])
 561   })
 562 })