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

   1 /* eslint-disable @typescript-eslint/no-unused-expressions,@typescript-eslint/require-await */
   2
   3 import 'mocha'
   4 import { expect } from 'chai'
   5 import { pathExists, readdir, remove } from 'fs-extra'
   6 import { join } from 'path'
   7 import { FIXTURE_URLS, testCaptionFile, testImage } from '@server/tests/shared'
   8 import { areHttpImportTestsDisabled } from '@shared/core-utils'
   9 import { HttpStatusCode, Video, VideoImportState, VideoPrivacy, VideoResolution, VideoState } from '@shared/models'
  10 import {
  11   cleanupTests,
  12   createMultipleServers,
  13   createSingleServer,
  14   doubleFollow,
  15   PeerTubeServer,
  16   setAccessTokensToServers,
  17   setDefaultVideoChannel,
  18   waitJobs
  19 } from '@shared/server-commands'
  20
  21 async function checkVideosServer1 (server: PeerTubeServer, idHttp: string, idMagnet: string, idTorrent: string) {
  22   const videoHttp = await server.videos.get({ id: idHttp })
  23
  24   expect(videoHttp.name).to.equal('small video - youtube')
  25   // FIXME: youtube-dl seems broken
  26   // expect(videoHttp.category.label).to.equal('News & Politics')
  27   // expect(videoHttp.licence.label).to.equal('Attribution')
  28   expect(videoHttp.language.label).to.equal('Unknown')
  29   expect(videoHttp.nsfw).to.be.false
  30   expect(videoHttp.description).to.equal('this is a super description')
  31   expect(videoHttp.tags).to.deep.equal([ 'tag1', 'tag2' ])
  32   expect(videoHttp.files).to.have.lengthOf(1)
  33
  34   const originallyPublishedAt = new Date(videoHttp.originallyPublishedAt)
  35   expect(originallyPublishedAt.getDate()).to.equal(14)
  36   expect(originallyPublishedAt.getMonth()).to.equal(0)
  37   expect(originallyPublishedAt.getFullYear()).to.equal(2019)
  38
  39   const videoMagnet = await server.videos.get({ id: idMagnet })
  40   const videoTorrent = await server.videos.get({ id: idTorrent })
  41
  42   for (const video of [ videoMagnet, videoTorrent ]) {
  43     expect(video.category.label).to.equal('Misc')
  44     expect(video.licence.label).to.equal('Unknown')
  45     expect(video.language.label).to.equal('Unknown')
  46     expect(video.nsfw).to.be.false
  47     expect(video.description).to.equal('this is a super torrent description')
  48     expect(video.tags).to.deep.equal([ 'tag_torrent1', 'tag_torrent2' ])
  49     expect(video.files).to.have.lengthOf(1)
  50   }
  51
  52   expect(videoTorrent.name).to.contain('你好 世界 720p.mp4')
  53   expect(videoMagnet.name).to.contain('super peertube2 video')
  54
  55   const bodyCaptions = await server.captions.list({ videoId: idHttp })
  56   expect(bodyCaptions.total).to.equal(2)
  57 }
  58
  59 async function checkVideoServer2 (server: PeerTubeServer, id: number | string) {
  60   const video = await server.videos.get({ id })
  61
  62   expect(video.name).to.equal('my super name')
  63   expect(video.category.label).to.equal('Entertainment')
  64   expect(video.licence.label).to.equal('Public Domain Dedication')
  65   expect(video.language.label).to.equal('English')
  66   expect(video.nsfw).to.be.false
  67   expect(video.description).to.equal('my super description')
  68   expect(video.tags).to.deep.equal([ 'supertag1', 'supertag2' ])
  69
  70   expect(video.files).to.have.lengthOf(1)
  71
  72   const bodyCaptions = await server.captions.list({ videoId: id })
  73   expect(bodyCaptions.total).to.equal(2)
  74 }
  75
  76 describe('Test video imports', function () {
  77
  78   if (areHttpImportTestsDisabled()) return
  79
  80   function runSuite (mode: 'youtube-dl' | 'yt-dlp') {
  81
  82     describe('Import ' + mode, function () {
  83       let servers: PeerTubeServer[] = []
  84
  85       before(async function () {
  86         this.timeout(30_000)
  87
  88         // Run servers
  89         servers = await createMultipleServers(2, {
  90           import: {
  91             videos: {
  92               http: {
  93                 youtube_dl_release: {
  94                   url: mode === 'youtube-dl'
  95                     ? 'https://yt-dl.org/downloads/latest/youtube-dl'
  96                     : 'https://api.github.com/repos/yt-dlp/yt-dlp/releases',
  97
  98                   name: mode
  99                 }
 100               }
 101             }
 102           }
 103         })
 104
 105         await setAccessTokensToServers(servers)
 106         await setDefaultVideoChannel(servers)
 107
 108         await doubleFollow(servers[0], servers[1])
 109       })
 110
 111       it('Should import videos on server 1', async function () {
 112         this.timeout(60_000)
 113
 114         const baseAttributes = {
 115           channelId: servers[0].store.channel.id,
 116           privacy: VideoPrivacy.PUBLIC
 117         }
 118
 119         {
 120           const attributes = { ...baseAttributes, targetUrl: FIXTURE_URLS.youtube }
 121           const { video } = await servers[0].imports.importVideo({ attributes })
 122           expect(video.name).to.equal('small video - youtube')
 123
 124           {
 125             expect(video.thumbnailPath).to.match(new RegExp(`^/static/thumbnails/.+.jpg$`))
 126             expect(video.previewPath).to.match(new RegExp(`^/lazy-static/previews/.+.jpg$`))
 127
 128             const suffix = mode === 'yt-dlp'
 129               ? '_yt_dlp'
 130               : ''
 131
 132             await testImage(servers[0].url, 'video_import_thumbnail' + suffix, video.thumbnailPath)
 133             await testImage(servers[0].url, 'video_import_preview' + suffix, video.previewPath)
 134           }
 135
 136           const bodyCaptions = await servers[0].captions.list({ videoId: video.id })
 137           const videoCaptions = bodyCaptions.data
 138           expect(videoCaptions).to.have.lengthOf(2)
 139
 140           {
 141             const enCaption = videoCaptions.find(caption => caption.language.id === 'en')
 142             expect(enCaption).to.exist
 143             expect(enCaption.language.label).to.equal('English')
 144             expect(enCaption.captionPath).to.match(new RegExp(`^/lazy-static/video-captions/.+-en.vtt$`))
 145
 146             const regex = `WEBVTT[ \n]+Kind: captions[ \n]+Language: en[ \n]+00:00:01.600 --> 00:00:04.200[ \n]+English \\(US\\)[ \n]+` +
 147               `00:00:05.900 --> 00:00:07.999[ \n]+This is a subtitle in American English[ \n]+` +
 148               `00:00:10.000 --> 00:00:14.000[ \n]+Adding subtitles is very easy to do`
 149             await testCaptionFile(servers[0].url, enCaption.captionPath, new RegExp(regex))
 150           }
 151
 152           {
 153             const frCaption = videoCaptions.find(caption => caption.language.id === 'fr')
 154             expect(frCaption).to.exist
 155             expect(frCaption.language.label).to.equal('French')
 156             expect(frCaption.captionPath).to.match(new RegExp(`^/lazy-static/video-captions/.+-fr.vtt`))
 157
 158             const regex = `WEBVTT[ \n]+Kind: captions[ \n]+Language: fr[ \n]+00:00:01.600 --> 00:00:04.200[ \n]+` +
 159               `Français \\(FR\\)[ \n]+00:00:05.900 --> 00:00:07.999[ \n]+C'est un sous-titre français[ \n]+` +
 160               `00:00:10.000 --> 00:00:14.000[ \n]+Ajouter un sous-titre est vraiment facile`
 161
 162             await testCaptionFile(servers[0].url, frCaption.captionPath, new RegExp(regex))
 163           }
 164         }
 165
 166         {
 167           const attributes = {
 168             ...baseAttributes,
 169             magnetUri: FIXTURE_URLS.magnet,
 170             description: 'this is a super torrent description',
 171             tags: [ 'tag_torrent1', 'tag_torrent2' ]
 172           }
 173           const { video } = await servers[0].imports.importVideo({ attributes })
 174           expect(video.name).to.equal('super peertube2 video')
 175         }
 176
 177         {
 178           const attributes = {
 179             ...baseAttributes,
 180             torrentfile: 'video-720p.torrent' as any,
 181             description: 'this is a super torrent description',
 182             tags: [ 'tag_torrent1', 'tag_torrent2' ]
 183           }
 184           const { video } = await servers[0].imports.importVideo({ attributes })
 185           expect(video.name).to.equal('你好 世界 720p.mp4')
 186         }
 187       })
 188
 189       it('Should list the videos to import in my videos on server 1', async function () {
 190         const { total, data } = await servers[0].videos.listMyVideos({ sort: 'createdAt' })
 191
 192         expect(total).to.equal(3)
 193
 194         expect(data).to.have.lengthOf(3)
 195         expect(data[0].name).to.equal('small video - youtube')
 196         expect(data[1].name).to.equal('super peertube2 video')
 197         expect(data[2].name).to.equal('你好 世界 720p.mp4')
 198       })
 199
 200       it('Should list the videos to import in my imports on server 1', async function () {
 201         const { total, data: videoImports } = await servers[0].imports.getMyVideoImports({ sort: '-createdAt' })
 202         expect(total).to.equal(3)
 203
 204         expect(videoImports).to.have.lengthOf(3)
 205
 206         expect(videoImports[2].targetUrl).to.equal(FIXTURE_URLS.youtube)
 207         expect(videoImports[2].magnetUri).to.be.null
 208         expect(videoImports[2].torrentName).to.be.null
 209         expect(videoImports[2].video.name).to.equal('small video - youtube')
 210
 211         expect(videoImports[1].targetUrl).to.be.null
 212         expect(videoImports[1].magnetUri).to.equal(FIXTURE_URLS.magnet)
 213         expect(videoImports[1].torrentName).to.be.null
 214         expect(videoImports[1].video.name).to.equal('super peertube2 video')
 215
 216         expect(videoImports[0].targetUrl).to.be.null
 217         expect(videoImports[0].magnetUri).to.be.null
 218         expect(videoImports[0].torrentName).to.equal('video-720p.torrent')
 219         expect(videoImports[0].video.name).to.equal('你好 世界 720p.mp4')
 220       })
 221
 222       it('Should have the video listed on the two instances', async function () {
 223         this.timeout(120_000)
 224
 225         await waitJobs(servers)
 226
 227         for (const server of servers) {
 228           const { total, data } = await server.videos.list()
 229           expect(total).to.equal(3)
 230           expect(data).to.have.lengthOf(3)
 231
 232           const [ videoHttp, videoMagnet, videoTorrent ] = data
 233           await checkVideosServer1(server, videoHttp.uuid, videoMagnet.uuid, videoTorrent.uuid)
 234         }
 235       })
 236
 237       it('Should import a video on server 2 with some fields', async function () {
 238         this.timeout(60_000)
 239
 240         const attributes = {
 241           targetUrl: FIXTURE_URLS.youtube,
 242           channelId: servers[1].store.channel.id,
 243           privacy: VideoPrivacy.PUBLIC,
 244           category: 10,
 245           licence: 7,
 246           language: 'en',
 247           name: 'my super name',
 248           description: 'my super description',
 249           tags: [ 'supertag1', 'supertag2' ]
 250         }
 251         const { video } = await servers[1].imports.importVideo({ attributes })
 252         expect(video.name).to.equal('my super name')
 253       })
 254
 255       it('Should have the videos listed on the two instances', async function () {
 256         this.timeout(120_000)
 257
 258         await waitJobs(servers)
 259
 260         for (const server of servers) {
 261           const { total, data } = await server.videos.list()
 262           expect(total).to.equal(4)
 263           expect(data).to.have.lengthOf(4)
 264
 265           await checkVideoServer2(server, data[0].uuid)
 266
 267           const [ , videoHttp, videoMagnet, videoTorrent ] = data
 268           await checkVideosServer1(server, videoHttp.uuid, videoMagnet.uuid, videoTorrent.uuid)
 269         }
 270       })
 271
 272       it('Should import a video that will be transcoded', async function () {
 273         this.timeout(240_000)
 274
 275         const attributes = {
 276           name: 'transcoded video',
 277           magnetUri: FIXTURE_URLS.magnet,
 278           channelId: servers[1].store.channel.id,
 279           privacy: VideoPrivacy.PUBLIC
 280         }
 281         const { video } = await servers[1].imports.importVideo({ attributes })
 282         const videoUUID = video.uuid
 283
 284         await waitJobs(servers)
 285
 286         for (const server of servers) {
 287           const video = await server.videos.get({ id: videoUUID })
 288
 289           expect(video.name).to.equal('transcoded video')
 290           expect(video.files).to.have.lengthOf(4)
 291         }
 292       })
 293
 294       it('Should import no HDR version on a HDR video', async function () {
 295         this.timeout(300_000)
 296
 297         const config = {
 298           transcoding: {
 299             enabled: true,
 300             resolutions: {
 301               '144p': true,
 302               '240p': true,
 303               '360p': false,
 304               '480p': false,
 305               '720p': false,
 306               '1080p': false, // the resulting resolution shouldn't be higher than this, and not vp9.2/av01
 307               '1440p': false,
 308               '2160p': false
 309             },
 310             webtorrent: { enabled: true },
 311             hls: { enabled: false }
 312           },
 313           import: {
 314             videos: {
 315               http: {
 316                 enabled: true
 317               },
 318               torrent: {
 319                 enabled: true
 320               }
 321             }
 322           }
 323         }
 324         await servers[0].config.updateCustomSubConfig({ newConfig: config })
 325
 326         const attributes = {
 327           name: 'hdr video',
 328           targetUrl: FIXTURE_URLS.youtubeHDR,
 329           channelId: servers[0].store.channel.id,
 330           privacy: VideoPrivacy.PUBLIC
 331         }
 332         const { video: videoImported } = await servers[0].imports.importVideo({ attributes })
 333         const videoUUID = videoImported.uuid
 334
 335         await waitJobs(servers)
 336
 337         // test resolution
 338         const video = await servers[0].videos.get({ id: videoUUID })
 339         expect(video.name).to.equal('hdr video')
 340         const maxResolution = Math.max.apply(Math, video.files.map(function (o) { return o.resolution.id }))
 341         expect(maxResolution, 'expected max resolution not met').to.equals(VideoResolution.H_240P)
 342       })
 343
 344       it('Should import a peertube video', async function () {
 345         this.timeout(120_000)
 346
 347         const toTest = [ FIXTURE_URLS.peertube_long ]
 348
 349         // TODO: include peertube_short when https://github.com/ytdl-org/youtube-dl/pull/29475 is merged
 350         if (mode === 'yt-dlp') {
 351           toTest.push(FIXTURE_URLS.peertube_short)
 352         }
 353
 354         for (const targetUrl of toTest) {
 355           await servers[0].config.disableTranscoding()
 356
 357           const attributes = {
 358             targetUrl,
 359             channelId: servers[0].store.channel.id,
 360             privacy: VideoPrivacy.PUBLIC
 361           }
 362           const { video } = await servers[0].imports.importVideo({ attributes })
 363           const videoUUID = video.uuid
 364
 365           await waitJobs(servers)
 366
 367           for (const server of servers) {
 368             const video = await server.videos.get({ id: videoUUID })
 369
 370             expect(video.name).to.equal('E2E tests')
 371           }
 372         }
 373       })
 374
 375       after(async function () {
 376         await cleanupTests(servers)
 377       })
 378     })
 379   }
 380
 381   runSuite('youtube-dl')
 382
 383   runSuite('yt-dlp')
 384
 385   describe('Delete/cancel an import', function () {
 386     let server: PeerTubeServer
 387
 388     let finishedImportId: number
 389     let finishedVideo: Video
 390     let pendingImportId: number
 391
 392     async function importVideo (name: string) {
 393       const attributes = { name, channelId: server.store.channel.id, targetUrl: FIXTURE_URLS.goodVideo }
 394       const res = await server.imports.importVideo({ attributes })
 395
 396       return res.id
 397     }
 398
 399     before(async function () {
 400       this.timeout(120_000)
 401
 402       server = await createSingleServer(1)
 403
 404       await setAccessTokensToServers([ server ])
 405       await setDefaultVideoChannel([ server ])
 406
 407       finishedImportId = await importVideo('finished')
 408       await waitJobs([ server ])
 409
 410       await server.jobs.pauseJobQueue()
 411       pendingImportId = await importVideo('pending')
 412
 413       const { data } = await server.imports.getMyVideoImports()
 414       expect(data).to.have.lengthOf(2)
 415
 416       finishedVideo = data.find(i => i.id === finishedImportId).video
 417     })
 418
 419     it('Should delete a video import', async function () {
 420       await server.imports.delete({ importId: finishedImportId })
 421
 422       const { data } = await server.imports.getMyVideoImports()
 423       expect(data).to.have.lengthOf(1)
 424       expect(data[0].id).to.equal(pendingImportId)
 425       expect(data[0].state.id).to.equal(VideoImportState.PENDING)
 426     })
 427
 428     it('Should not have deleted the associated video', async function () {
 429       const video = await server.videos.get({ id: finishedVideo.id, token: server.accessToken, expectedStatus: HttpStatusCode.OK_200 })
 430       expect(video.name).to.equal('finished')
 431       expect(video.state.id).to.equal(VideoState.PUBLISHED)
 432     })
 433
 434     it('Should cancel a video import', async function () {
 435       await server.imports.cancel({ importId: pendingImportId })
 436
 437       const { data } = await server.imports.getMyVideoImports()
 438       expect(data).to.have.lengthOf(1)
 439       expect(data[0].id).to.equal(pendingImportId)
 440       expect(data[0].state.id).to.equal(VideoImportState.CANCELLED)
 441     })
 442
 443     it('Should not have processed the cancelled video import', async function () {
 444       this.timeout(60_000)
 445
 446       await server.jobs.resumeJobQueue()
 447
 448       await waitJobs([ server ])
 449
 450       const { data } = await server.imports.getMyVideoImports()
 451       expect(data).to.have.lengthOf(1)
 452       expect(data[0].id).to.equal(pendingImportId)
 453       expect(data[0].state.id).to.equal(VideoImportState.CANCELLED)
 454       expect(data[0].video.state.id).to.equal(VideoState.TO_IMPORT)
 455     })
 456
 457     it('Should delete the cancelled video import', async function () {
 458       await server.imports.delete({ importId: pendingImportId })
 459       const { data } = await server.imports.getMyVideoImports()
 460       expect(data).to.have.lengthOf(0)
 461     })
 462   })
 463
 464   describe('Auto update', function () {
 465     let server: PeerTubeServer
 466
 467     function quickPeerTubeImport () {
 468       const attributes = {
 469         targetUrl: FIXTURE_URLS.peertube_long,
 470         channelId: server.store.channel.id,
 471         privacy: VideoPrivacy.PUBLIC
 472       }
 473
 474       return server.imports.importVideo({ attributes })
 475     }
 476
 477     async function testBinaryUpdate (releaseUrl: string, releaseName: string) {
 478       await remove(join(server.servers.buildDirectory('bin'), releaseName))
 479
 480       await server.kill()
 481       await server.run({
 482         import: {
 483           videos: {
 484             http: {
 485               youtube_dl_release: {
 486                 url: releaseUrl,
 487                 name: releaseName
 488               }
 489             }
 490           }
 491         }
 492       })
 493
 494       await quickPeerTubeImport()
 495
 496       const base = server.servers.buildDirectory('bin')
 497       const content = await readdir(base)
 498       const binaryPath = join(base, releaseName)
 499
 500       expect(await pathExists(binaryPath), `${binaryPath} does not exist in ${base} (${content.join(', ')})`).to.be.true
 501     }
 502
 503     before(async function () {
 504       this.timeout(30_000)
 505
 506       // Run servers
 507       server = await createSingleServer(1)
 508
 509       await setAccessTokensToServers([ server ])
 510       await setDefaultVideoChannel([ server ])
 511     })
 512
 513     it('Should update youtube-dl from github URL', async function () {
 514       this.timeout(120_000)
 515
 516       await testBinaryUpdate('https://api.github.com/repos/ytdl-org/youtube-dl/releases', 'youtube-dl')
 517     })
 518
 519     it('Should update youtube-dl from raw URL', async function () {
 520       this.timeout(120_000)
 521
 522       await testBinaryUpdate('https://yt-dl.org/downloads/latest/youtube-dl', 'youtube-dl')
 523     })
 524
 525     it('Should update youtube-dl from youtube-dl fork', async function () {
 526       this.timeout(120_000)
 527
 528       await testBinaryUpdate('https://api.github.com/repos/yt-dlp/yt-dlp/releases', 'yt-dlp')
 529     })
 530
 531     after(async function () {
 532       await cleanupTests([ server ])
 533     })
 534   })
 535 })