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

/* eslint-disable @typescript-eslint/no-unused-expressions,@typescript-eslint/require-await */

import 'mocha'
import * as chai from 'chai'
import {
  areHttpImportTestsDisabled,
  cleanupTests,
  createMultipleServers,
  doubleFollow,
  FIXTURE_URLS,
  PeerTubeServer,
  setAccessTokensToServers,
  testCaptionFile,
  testImage,
  waitJobs
} from '@shared/extra-utils'
import { VideoPrivacy, VideoResolution } from '@shared/models'

const expect = chai.expect

describe('Test video imports', function () {
  let servers: PeerTubeServer[] = []
  let channelIdServer1: number
  let channelIdServer2: number

  if (areHttpImportTestsDisabled()) return

  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)
  }

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

    // Run servers
    servers = await createMultipleServers(2)

    await setAccessTokensToServers(servers)

    {
      const { videoChannels } = await servers[0].users.getMyInfo()
      channelIdServer1 = videoChannels[0].id
    }

    {
      const { videoChannels } = await servers[1].users.getMyInfo()
      channelIdServer2 = videoChannels[0].id
    }

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

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

    const baseAttributes = {
      channelId: channelIdServer1,
      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$`))

      await testImage(servers[0].url, 'video_import_thumbnail', video.thumbnailPath)
      await testImage(servers[0].url, 'video_import_preview', 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$`))
      await testCaptionFile(servers[0].url, enCaption.captionPath, `WEBVTT
Kind: captions
Language: en

00:00:01.600 --> 00:00:04.200
English (US)

00:00:05.900 --> 00:00:07.999
This is a subtitle in American English

00:00:10.000 --> 00:00:14.000
Adding subtitles is very easy to do`)

      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`))
      await testCaptionFile(servers[0].url, frCaption.captionPath, `WEBVTT
Kind: captions
Language: fr

00:00:01.600 --> 00:00:04.200
Français (FR)

00:00:05.900 --> 00:00:07.999
C'est un sous-titre français

00:00:10.000 --> 00:00:14.000
Ajouter un sous-titre est vraiment facile`)
    }

    {
      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 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: channelIdServer2,
      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(120_000)

    const attributes = {
      name: 'transcoded video',
      magnetUri: FIXTURE_URLS.magnet,
      channelId: channelIdServer2,
      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(120_000)

    const config = {
      transcoding: {
        enabled: true,
        resolutions: {
          '240p': false,
          '360p': false,
          '480p': false,
          '720p': false,
          '1080p': true, // 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: channelIdServer1,
      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_1080P)
  })

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

    // TODO: include peertube_short when https://github.com/ytdl-org/youtube-dl/pull/29475 is merged
    for (const targetUrl of [ FIXTURE_URLS.peertube_long ]) {
    // for (const targetUrl of [ FIXTURE_URLS.peertube_long, FIXTURE_URLS.peertube_short ]) {
      await servers[0].config.disableTranscoding()

      const attributes = {
        targetUrl,
        channelId: channelIdServer1,
        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)
  })
})