server/tests/api/server/config.ts

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