aboutsummaryrefslogtreecommitdiffhomepage
path: root/server/tests/api/videos/video-imports.ts
blob: 28da69e8e6b3f335b1134bec1bb1faede7cd93ac (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
/* eslint-disable @typescript-eslint/no-unused-expressions,@typescript-eslint/require-await */

import 'mocha'
import { expect } from 'chai'
import { pathExists, readdir, remove } from 'fs-extra'
import { join } from 'path'
import { FIXTURE_URLS, testCaptionFile, testImage } from '@server/tests/shared'
import { areHttpImportTestsDisabled } from '@shared/core-utils'
import { HttpStatusCode, Video, VideoImportState, VideoPrivacy, VideoResolution, VideoState } from '@shared/models'
import {
  cleanupTests,
  createMultipleServers,
  createSingleServer,
  doubleFollow,
  PeerTubeServer,
  setAccessTokensToServers,
  setDefaultVideoChannel,
  waitJobs
} from '@shared/server-commands'

async function checkVideosServer1 (server: PeerTubeServer, idHttp: string, idMagnet: string, idTorrent: string) {
  const videoHttp = await server.videos.get({ id: idHttp })

  expect(videoHttp.name).to.equal('small video - youtube')
  // FIXME: youtube-dl seems broken
  // expect(videoHttp.category.label).to.equal('News & Politics')
  // expect(videoHttp.licence.label).to.equal('Attribution')
  expect(videoHttp.language.label).to.equal('Unknown')
  expect(videoHttp.nsfw).to.be.false
  expect(videoHttp.description).to.equal('this is a super description')
  expect(videoHttp.tags).to.deep.equal([ 'tag1', 'tag2' ])
  expect(videoHttp.files).to.have.lengthOf(1)

  const originallyPublishedAt = new Date(videoHttp.originallyPublishedAt)
  expect(originallyPublishedAt.getDate()).to.equal(14)
  expect(originallyPublishedAt.getMonth()).to.equal(0)
  expect(originallyPublishedAt.getFullYear()).to.equal(2019)

  const videoMagnet = await server.videos.get({ id: idMagnet })
  const videoTorrent = await server.videos.get({ id: idTorrent })

  for (const video of [ videoMagnet, videoTorrent ]) {
    expect(video.category.label).to.equal('Misc')
    expect(video.licence.label).to.equal('Unknown')
    expect(video.language.label).to.equal('Unknown')
    expect(video.nsfw).to.be.false
    expect(video.description).to.equal('this is a super torrent description')
    expect(video.tags).to.deep.equal([ 'tag_torrent1', 'tag_torrent2' ])
    expect(video.files).to.have.lengthOf(1)
  }

  expect(videoTorrent.name).to.contain('你好 世界 720p.mp4')
  expect(videoMagnet.name).to.contain('super peertube2 video')

  const bodyCaptions = await server.captions.list({ videoId: idHttp })
  expect(bodyCaptions.total).to.equal(2)
}

async function checkVideoServer2 (server: PeerTubeServer, id: number | string) {
  const video = await server.videos.get({ id })

  expect(video.name).to.equal('my super name')
  expect(video.category.label).to.equal('Entertainment')
  expect(video.licence.label).to.equal('Public Domain Dedication')
  expect(video.language.label).to.equal('English')
  expect(video.nsfw).to.be.false
  expect(video.description).to.equal('my super description')
  expect(video.tags).to.deep.equal([ 'supertag1', 'supertag2' ])

  expect(video.files).to.have.lengthOf(1)

  const bodyCaptions = await server.captions.list({ videoId: id })
  expect(bodyCaptions.total).to.equal(2)
}

describe('Test video imports', function () {

  if (areHttpImportTestsDisabled()) return

  function runSuite (mode: 'youtube-dl' | 'yt-dlp') {

    describe('Import ' + mode, function () {
      let servers: PeerTubeServer[] = []

      before(async function () {
        this.timeout(30_000)

        // Run servers
        servers = await createMultipleServers(2, {
          import: {
            videos: {
              http: {
                youtube_dl_release: {
                  url: mode === 'youtube-dl'
                    ? 'https://yt-dl.org/downloads/latest/youtube-dl'
                    : 'https://api.github.com/repos/yt-dlp/yt-dlp/releases',

                  name: mode
                }
              }
            }
          }
        })

        await setAccessTokensToServers(servers)
        await setDefaultVideoChannel(servers)

        await doubleFollow(servers[0], servers[1])
      })

      it('Should import videos on server 1', async function () {
        this.timeout(60_000)

        const baseAttributes = {
          channelId: servers[0].store.channel.id,
          privacy: VideoPrivacy.PUBLIC
        }

        {
          const attributes = { ...baseAttributes, targetUrl: FIXTURE_URLS.youtube }
          const { video } = await servers[0].imports.importVideo({ attributes })
          expect(video.name).to.equal('small video - youtube')

          {
            expect(video.thumbnailPath).to.match(new RegExp(`^/static/thumbnails/.+.jpg$`))
            expect(video.previewPath).to.match(new RegExp(`^/lazy-static/previews/.+.jpg$`))

            const suffix = mode === 'yt-dlp'
              ? '_yt_dlp'
              : ''

            await testImage(servers[0].url, 'video_import_thumbnail' + suffix, video.thumbnailPath)
            await testImage(servers[0].url, 'video_import_preview' + suffix, video.previewPath)
          }

          const bodyCaptions = await servers[0].captions.list({ videoId: video.id })
          const videoCaptions = bodyCaptions.data
          expect(videoCaptions).to.have.lengthOf(2)

          {
            const enCaption = videoCaptions.find(caption => caption.language.id === 'en')
            expect(enCaption).to.exist
            expect(enCaption.language.label).to.equal('English')
            expect(enCaption.captionPath).to.match(new RegExp(`^/lazy-static/video-captions/.+-en.vtt$`))

            const regex = `WEBVTT[ \n]+Kind: captions[ \n]+Language: en[ \n]+00:00:01.600 --> 00:00:04.200[ \n]+English \\(US\\)[ \n]+` +
              `00:00:05.900 --> 00:00:07.999[ \n]+This is a subtitle in American English[ \n]+` +
              `00:00:10.000 --> 00:00:14.000[ \n]+Adding subtitles is very easy to do`
            await testCaptionFile(servers[0].url, enCaption.captionPath, new RegExp(regex))
          }

          {
            const frCaption = videoCaptions.find(caption => caption.language.id === 'fr')
            expect(frCaption).to.exist
            expect(frCaption.language.label).to.equal('French')
            expect(frCaption.captionPath).to.match(new RegExp(`^/lazy-static/video-captions/.+-fr.vtt`))

            const regex = `WEBVTT[ \n]+Kind: captions[ \n]+Language: fr[ \n]+00:00:01.600 --> 00:00:04.200[ \n]+` +
              `Français \\(FR\\)[ \n]+00:00:05.900 --> 00:00:07.999[ \n]+C'est un sous-titre français[ \n]+` +
              `00:00:10.000 --> 00:00:14.000[ \n]+Ajouter un sous-titre est vraiment facile`

            await testCaptionFile(servers[0].url, frCaption.captionPath, new RegExp(regex))
          }
        }

        {
          const attributes = {
            ...baseAttributes,
            magnetUri: FIXTURE_URLS.magnet,
            description: 'this is a super torrent description',
            tags: [ 'tag_torrent1', 'tag_torrent2' ]
          }
          const { video } = await servers[0].imports.importVideo({ attributes })
          expect(video.name).to.equal('super peertube2 video')
        }

        {
          const attributes = {
            ...baseAttributes,
            torrentfile: 'video-720p.torrent' as any,
            description: 'this is a super torrent description',
            tags: [ 'tag_torrent1', 'tag_torrent2' ]
          }
          const { video } = await servers[0].imports.importVideo({ attributes })
          expect(video.name).to.equal('你好 世界 720p.mp4')
        }
      })

      it('Should list the videos to import in my videos on server 1', async function () {
        const { total, data } = await servers[0].videos.listMyVideos({ sort: 'createdAt' })

        expect(total).to.equal(3)

        expect(data).to.have.lengthOf(3)
        expect(data[0].name).to.equal('small video - youtube')
        expect(data[1].name).to.equal('super peertube2 video')
        expect(data[2].name).to.equal('你好 世界 720p.mp4')
      })

      it('Should list the videos to import in my imports on server 1', async function () {
        const { total, data: videoImports } = await servers[0].imports.getMyVideoImports({ sort: '-createdAt' })
        expect(total).to.equal(3)

        expect(videoImports).to.have.lengthOf(3)

        expect(videoImports[2].targetUrl).to.equal(FIXTURE_URLS.youtube)
        expect(videoImports[2].magnetUri).to.be.null
        expect(videoImports[2].torrentName).to.be.null
        expect(videoImports[2].video.name).to.equal('small video - youtube')

        expect(videoImports[1].targetUrl).to.be.null
        expect(videoImports[1].magnetUri).to.equal(FIXTURE_URLS.magnet)
        expect(videoImports[1].torrentName).to.be.null
        expect(videoImports[1].video.name).to.equal('super peertube2 video')

        expect(videoImports[0].targetUrl).to.be.null
        expect(videoImports[0].magnetUri).to.be.null
        expect(videoImports[0].torrentName).to.equal('video-720p.torrent')
        expect(videoImports[0].video.name).to.equal('你好 世界 720p.mp4')
      })

      it('Should filter my imports on target URL', async function () {
        const { total, data: videoImports } = await servers[0].imports.getMyVideoImports({ targetUrl: FIXTURE_URLS.youtube })
        expect(total).to.equal(1)
        expect(videoImports).to.have.lengthOf(1)

        expect(videoImports[0].targetUrl).to.equal(FIXTURE_URLS.youtube)
      })

      it('Should have the video listed on the two instances', async function () {
        this.timeout(120_000)

        await waitJobs(servers)

        for (const server of servers) {
          const { total, data } = await server.videos.list()
          expect(total).to.equal(3)
          expect(data).to.have.lengthOf(3)

          const [ videoHttp, videoMagnet, videoTorrent ] = data
          await checkVideosServer1(server, videoHttp.uuid, videoMagnet.uuid, videoTorrent.uuid)
        }
      })

      it('Should import a video on server 2 with some fields', async function () {
        this.timeout(60_000)

        const attributes = {
          targetUrl: FIXTURE_URLS.youtube,
          channelId: servers[1].store.channel.id,
          privacy: VideoPrivacy.PUBLIC,
          category: 10,
          licence: 7,
          language: 'en',
          name: 'my super name',
          description: 'my super description',
          tags: [ 'supertag1', 'supertag2' ]
        }
        const { video } = await servers[1].imports.importVideo({ attributes })
        expect(video.name).to.equal('my super name')
      })

      it('Should have the videos listed on the two instances', async function () {
        this.timeout(120_000)

        await waitJobs(servers)

        for (const server of servers) {
          const { total, data } = await server.videos.list()
          expect(total).to.equal(4)
          expect(data).to.have.lengthOf(4)

          await checkVideoServer2(server, data[0].uuid)

          const [ , videoHttp, videoMagnet, videoTorrent ] = data
          await checkVideosServer1(server, videoHttp.uuid, videoMagnet.uuid, videoTorrent.uuid)
        }
      })

      it('Should import a video that will be transcoded', async function () {
        this.timeout(240_000)

        const attributes = {
          name: 'transcoded video',
          magnetUri: FIXTURE_URLS.magnet,
          channelId: servers[1].store.channel.id,
          privacy: VideoPrivacy.PUBLIC
        }
        const { video } = await servers[1].imports.importVideo({ attributes })
        const videoUUID = video.uuid

        await waitJobs(servers)

        for (const server of servers) {
          const video = await server.videos.get({ id: videoUUID })

          expect(video.name).to.equal('transcoded video')
          expect(video.files).to.have.lengthOf(4)
        }
      })

      it('Should import no HDR version on a HDR video', async function () {
        this.timeout(300_000)

        const config = {
          transcoding: {
            enabled: true,
            resolutions: {
              '144p': true,
              '240p': true,
              '360p': false,
              '480p': false,
              '720p': false,
              '1080p': false, // the resulting resolution shouldn't be higher than this, and not vp9.2/av01
              '1440p': false,
              '2160p': false
            },
            webtorrent: { enabled: true },
            hls: { enabled: false }
          },
          import: {
            videos: {
              http: {
                enabled: true
              },
              torrent: {
                enabled: true
              }
            }
          }
        }
        await servers[0].config.updateCustomSubConfig({ newConfig: config })

        const attributes = {
          name: 'hdr video',
          targetUrl: FIXTURE_URLS.youtubeHDR,
          channelId: servers[0].store.channel.id,
          privacy: VideoPrivacy.PUBLIC
        }
        const { video: videoImported } = await servers[0].imports.importVideo({ attributes })
        const videoUUID = videoImported.uuid

        await waitJobs(servers)

        // test resolution
        const video = await servers[0].videos.get({ id: videoUUID })
        expect(video.name).to.equal('hdr video')
        const maxResolution = Math.max.apply(Math, video.files.map(function (o) { return o.resolution.id }))
        expect(maxResolution, 'expected max resolution not met').to.equals(VideoResolution.H_240P)
      })

      it('Should import a peertube video', async function () {
        this.timeout(120_000)

        const toTest = [ FIXTURE_URLS.peertube_long ]

        // TODO: include peertube_short when https://github.com/ytdl-org/youtube-dl/pull/29475 is merged
        if (mode === 'yt-dlp') {
          toTest.push(FIXTURE_URLS.peertube_short)
        }

        for (const targetUrl of toTest) {
          await servers[0].config.disableTranscoding()

          const attributes = {
            targetUrl,
            channelId: servers[0].store.channel.id,
            privacy: VideoPrivacy.PUBLIC
          }
          const { video } = await servers[0].imports.importVideo({ attributes })
          const videoUUID = video.uuid

          await waitJobs(servers)

          for (const server of servers) {
            const video = await server.videos.get({ id: videoUUID })

            expect(video.name).to.equal('E2E tests')
          }
        }
      })

      after(async function () {
        await cleanupTests(servers)
      })
    })
  }

  runSuite('youtube-dl')

  runSuite('yt-dlp')

  describe('Delete/cancel an import', function () {
    let server: PeerTubeServer

    let finishedImportId: number
    let finishedVideo: Video
    let pendingImportId: number

    async function importVideo (name: string) {
      const attributes = { name, channelId: server.store.channel.id, targetUrl: FIXTURE_URLS.goodVideo }
      const res = await server.imports.importVideo({ attributes })

      return res.id
    }

    before(async function () {
      this.timeout(120_000)

      server = await createSingleServer(1)

      await setAccessTokensToServers([ server ])
      await setDefaultVideoChannel([ server ])

      finishedImportId = await importVideo('finished')
      await waitJobs([ server ])

      await server.jobs.pauseJobQueue()
      pendingImportId = await importVideo('pending')

      const { data } = await server.imports.getMyVideoImports()
      expect(data).to.have.lengthOf(2)

      finishedVideo = data.find(i => i.id === finishedImportId).video
    })

    it('Should delete a video import', async function () {
      await server.imports.delete({ importId: finishedImportId })

      const { data } = await server.imports.getMyVideoImports()
      expect(data).to.have.lengthOf(1)
      expect(data[0].id).to.equal(pendingImportId)
      expect(data[0].state.id).to.equal(VideoImportState.PENDING)
    })

    it('Should not have deleted the associated video', async function () {
      const video = await server.videos.get({ id: finishedVideo.id, token: server.accessToken, expectedStatus: HttpStatusCode.OK_200 })
      expect(video.name).to.equal('finished')
      expect(video.state.id).to.equal(VideoState.PUBLISHED)
    })

    it('Should cancel a video import', async function () {
      await server.imports.cancel({ importId: pendingImportId })

      const { data } = await server.imports.getMyVideoImports()
      expect(data).to.have.lengthOf(1)
      expect(data[0].id).to.equal(pendingImportId)
      expect(data[0].state.id).to.equal(VideoImportState.CANCELLED)
    })

    it('Should not have processed the cancelled video import', async function () {
      this.timeout(60_000)

      await server.jobs.resumeJobQueue()

      await waitJobs([ server ])

      const { data } = await server.imports.getMyVideoImports()
      expect(data).to.have.lengthOf(1)
      expect(data[0].id).to.equal(pendingImportId)
      expect(data[0].state.id).to.equal(VideoImportState.CANCELLED)
      expect(data[0].video.state.id).to.equal(VideoState.TO_IMPORT)
    })

    it('Should delete the cancelled video import', async function () {
      await server.imports.delete({ importId: pendingImportId })
      const { data } = await server.imports.getMyVideoImports()
      expect(data).to.have.lengthOf(0)
    })

    after(async function () {
      await cleanupTests([ server ])
    })
  })

  describe('Auto update', function () {
    let server: PeerTubeServer

    function quickPeerTubeImport () {
      const attributes = {
        targetUrl: FIXTURE_URLS.peertube_long,
        channelId: server.store.channel.id,
        privacy: VideoPrivacy.PUBLIC
      }

      return server.imports.importVideo({ attributes })
    }

    async function testBinaryUpdate (releaseUrl: string, releaseName: string) {
      await remove(join(server.servers.buildDirectory('bin'), releaseName))

      await server.kill()
      await server.run({
        import: {
          videos: {
            http: {
              youtube_dl_release: {
                url: releaseUrl,
                name: releaseName
              }
            }
          }
        }
      })

      await quickPeerTubeImport()

      const base = server.servers.buildDirectory('bin')
      const content = await readdir(base)
      const binaryPath = join(base, releaseName)

      expect(await pathExists(binaryPath), `${binaryPath} does not exist in ${base} (${content.join(', ')})`).to.be.true
    }

    before(async function () {
      this.timeout(30_000)

      // Run servers
      server = await createSingleServer(1)

      await setAccessTokensToServers([ server ])
      await setDefaultVideoChannel([ server ])
    })

    it('Should update youtube-dl from github URL', async function () {
      this.timeout(120_000)

      await testBinaryUpdate('https://api.github.com/repos/ytdl-org/youtube-dl/releases', 'youtube-dl')
    })

    it('Should update youtube-dl from raw URL', async function () {
      this.timeout(120_000)

      await testBinaryUpdate('https://yt-dl.org/downloads/latest/youtube-dl', 'youtube-dl')
    })

    it('Should update youtube-dl from youtube-dl fork', async function () {
      this.timeout(120_000)

      await testBinaryUpdate('https://api.github.com/repos/yt-dlp/yt-dlp/releases', 'yt-dlp')
    })

    after(async function () {
      await cleanupTests([ server ])
    })
  })
})