path: root/server/tests/api/videos/video-blacklist.ts

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

import * as chai from 'chai'
import { orderBy } from 'lodash'
import 'mocha'
import {
  addVideoToBlacklist,
  cleanupTests,
  createUser,
  flushAndRunMultipleServers,
  getBlacklistedVideosList,
  getMyUserInformation,
  getMyVideos,
  getVideosList,
  killallServers,
  removeVideoFromBlacklist,
  reRunServer,
  searchVideo,
  ServerInfo,
  setAccessTokensToServers,
  updateVideo,
  updateVideoBlacklist,
  uploadVideo,
  userLogin
} from '../../../../shared/extra-utils/index'
import { doubleFollow } from '../../../../shared/extra-utils/server/follows'
import { waitJobs } from '../../../../shared/extra-utils/server/jobs'
import { VideoBlacklist, VideoBlacklistType } from '../../../../shared/models/videos'
import { UserAdminFlag } from '../../../../shared/models/users/user-flag.model'
import { User, UserRole } from '../../../../shared/models/users'
import { getMagnetURI, getYoutubeVideoUrl, importVideo } from '../../../../shared/extra-utils/videos/video-imports'

const expect = chai.expect

describe('Test video blacklist', function () {
  let servers: ServerInfo[] = []
  let videoId: number

  async function blacklistVideosOnServer (server: ServerInfo) {
    const res = await getVideosList(server.url)

    const videos = res.body.data
    for (const video of videos) {
      await addVideoToBlacklist(server.url, server.accessToken, video.id, 'super reason')
    }
  }

  before(async function () {
    this.timeout(50000)

    // Run servers
    servers = await flushAndRunMultipleServers(2)

    // Get the access tokens
    await setAccessTokensToServers(servers)

    // Server 1 and server 2 follow each other
    await doubleFollow(servers[0], servers[1])

    // Upload 2 videos on server 2
    await uploadVideo(servers[1].url, servers[1].accessToken, { name: 'My 1st video', description: 'A video on server 2' })
    await uploadVideo(servers[1].url, servers[1].accessToken, { name: 'My 2nd video', description: 'A video on server 2' })

    // Wait videos propagation, server 2 has transcoding enabled
    await waitJobs(servers)

    // Blacklist the two videos on server 1
    await blacklistVideosOnServer(servers[0])
  })

  describe('When listing/searching videos', function () {

    it('Should not have the video blacklisted in videos list/search on server 1', async function () {
      {
        const res = await getVideosList(servers[0].url)

        expect(res.body.total).to.equal(0)
        expect(res.body.data).to.be.an('array')
        expect(res.body.data.length).to.equal(0)
      }

      {
        const res = await searchVideo(servers[0].url, 'name')

        expect(res.body.total).to.equal(0)
        expect(res.body.data).to.be.an('array')
        expect(res.body.data.length).to.equal(0)
      }
    })

    it('Should have the blacklisted video in videos list/search on server 2', async function () {
      {
        const res = await getVideosList(servers[1].url)

        expect(res.body.total).to.equal(2)
        expect(res.body.data).to.be.an('array')
        expect(res.body.data.length).to.equal(2)
      }

      {
        const res = await searchVideo(servers[1].url, 'video')

        expect(res.body.total).to.equal(2)
        expect(res.body.data).to.be.an('array')
        expect(res.body.data.length).to.equal(2)
      }
    })
  })

  describe('When listing manually blacklisted videos', function () {
    it('Should display all the blacklisted videos', async function () {
      const res = await getBlacklistedVideosList({ url: servers[0].url, token: servers[0].accessToken })

      expect(res.body.total).to.equal(2)

      const blacklistedVideos = res.body.data
      expect(blacklistedVideos).to.be.an('array')
      expect(blacklistedVideos.length).to.equal(2)

      for (const blacklistedVideo of blacklistedVideos) {
        expect(blacklistedVideo.reason).to.equal('super reason')
        videoId = blacklistedVideo.video.id
      }
    })

    it('Should display all the blacklisted videos when applying manual type filter', async function () {
      const res = await getBlacklistedVideosList({
        url: servers[0].url,
        token: servers[0].accessToken,
        type: VideoBlacklistType.MANUAL
      })

      expect(res.body.total).to.equal(2)

      const blacklistedVideos = res.body.data
      expect(blacklistedVideos).to.be.an('array')
      expect(blacklistedVideos.length).to.equal(2)
    })

    it('Should display nothing when applying automatic type filter', async function () {
      const res = await getBlacklistedVideosList({
        url: servers[0].url,
        token: servers[0].accessToken,
        type: VideoBlacklistType.AUTO_BEFORE_PUBLISHED
      })

      expect(res.body.total).to.equal(0)

      const blacklistedVideos = res.body.data
      expect(blacklistedVideos).to.be.an('array')
      expect(blacklistedVideos.length).to.equal(0)
    })

    it('Should get the correct sort when sorting by descending id', async function () {
      const res = await getBlacklistedVideosList({ url: servers[0].url, token: servers[0].accessToken, sort: '-id' })
      expect(res.body.total).to.equal(2)

      const blacklistedVideos = res.body.data
      expect(blacklistedVideos).to.be.an('array')
      expect(blacklistedVideos.length).to.equal(2)

      const result = orderBy(res.body.data, [ 'id' ], [ 'desc' ])

      expect(blacklistedVideos).to.deep.equal(result)
    })

    it('Should get the correct sort when sorting by descending video name', async function () {
      const res = await getBlacklistedVideosList({ url: servers[0].url, token: servers[0].accessToken, sort: '-name' })
      expect(res.body.total).to.equal(2)

      const blacklistedVideos = res.body.data
      expect(blacklistedVideos).to.be.an('array')
      expect(blacklistedVideos.length).to.equal(2)

      const result = orderBy(res.body.data, [ 'name' ], [ 'desc' ])

      expect(blacklistedVideos).to.deep.equal(result)
    })

    it('Should get the correct sort when sorting by ascending creation date', async function () {
      const res = await getBlacklistedVideosList({ url: servers[0].url, token: servers[0].accessToken, sort: 'createdAt' })
      expect(res.body.total).to.equal(2)

      const blacklistedVideos = res.body.data
      expect(blacklistedVideos).to.be.an('array')
      expect(blacklistedVideos.length).to.equal(2)

      const result = orderBy(res.body.data, [ 'createdAt' ])

      expect(blacklistedVideos).to.deep.equal(result)
    })
  })

  describe('When updating blacklisted videos', function () {
    it('Should change the reason', async function () {
      await updateVideoBlacklist(servers[0].url, servers[0].accessToken, videoId, 'my super reason updated')

      const res = await getBlacklistedVideosList({ url: servers[0].url, token: servers[0].accessToken, sort: '-name' })
      const video = res.body.data.find(b => b.video.id === videoId)

      expect(video.reason).to.equal('my super reason updated')
    })
  })

  describe('When listing my videos', function () {
    it('Should display blacklisted videos', async function () {
      await blacklistVideosOnServer(servers[1])

      const res = await getMyVideos(servers[1].url, servers[1].accessToken, 0, 5)

      expect(res.body.total).to.equal(2)
      expect(res.body.data).to.have.lengthOf(2)

      for (const video of res.body.data) {
        expect(video.blacklisted).to.be.true
        expect(video.blacklistedReason).to.equal('super reason')
      }
    })
  })

  describe('When removing a blacklisted video', function () {
    let videoToRemove: VideoBlacklist
    let blacklist = []

    it('Should not have any video in videos list on server 1', async function () {
      const res = await getVideosList(servers[0].url)
      expect(res.body.total).to.equal(0)
      expect(res.body.data).to.be.an('array')
      expect(res.body.data.length).to.equal(0)
    })

    it('Should remove a video from the blacklist on server 1', async function () {
      // Get one video in the blacklist
      const res = await getBlacklistedVideosList({ url: servers[0].url, token: servers[0].accessToken, sort: '-name' })
      videoToRemove = res.body.data[0]
      blacklist = res.body.data.slice(1)

      // Remove it
      await removeVideoFromBlacklist(servers[0].url, servers[0].accessToken, videoToRemove.video.id)
    })

    it('Should have the ex-blacklisted video in videos list on server 1', async function () {
      const res = await getVideosList(servers[0].url)
      expect(res.body.total).to.equal(1)

      const videos = res.body.data
      expect(videos).to.be.an('array')
      expect(videos.length).to.equal(1)

      expect(videos[0].name).to.equal(videoToRemove.video.name)
      expect(videos[0].id).to.equal(videoToRemove.video.id)
    })

    it('Should not have the ex-blacklisted video in videos blacklist list on server 1', async function () {
      const res = await getBlacklistedVideosList({ url: servers[0].url, token: servers[0].accessToken, sort: '-name' })
      expect(res.body.total).to.equal(1)

      const videos = res.body.data
      expect(videos).to.be.an('array')
      expect(videos.length).to.equal(1)
      expect(videos).to.deep.equal(blacklist)
    })
  })

  describe('When blacklisting local videos', function () {
    let video3UUID: string
    let video4UUID: string

    before(async function () {
      this.timeout(10000)

      {
        const res = await uploadVideo(servers[0].url, servers[0].accessToken, { name: 'Video 3' })
        video3UUID = res.body.video.uuid
      }
      {
        const res = await uploadVideo(servers[0].url, servers[0].accessToken, { name: 'Video 4' })
        video4UUID = res.body.video.uuid
      }

      await waitJobs(servers)
    })

    it('Should blacklist video 3 and keep it federated', async function () {
      this.timeout(10000)

      await addVideoToBlacklist(servers[0].url, servers[0].accessToken, video3UUID, 'super reason', false)

      await waitJobs(servers)

      {
        const res = await getVideosList(servers[0].url)
        expect(res.body.data.find(v => v.uuid === video3UUID)).to.be.undefined
      }

      {
        const res = await getVideosList(servers[1].url)
        expect(res.body.data.find(v => v.uuid === video3UUID)).to.not.be.undefined
      }
    })

    it('Should unfederate the video', async function () {
      this.timeout(10000)

      await addVideoToBlacklist(servers[0].url, servers[0].accessToken, video4UUID, 'super reason', true)

      await waitJobs(servers)

      for (const server of servers) {
        const res = await getVideosList(server.url)
        expect(res.body.data.find(v => v.uuid === video4UUID)).to.be.undefined
      }
    })

    it('Should have the video unfederated even after an Update AP message', async function () {
      this.timeout(10000)

      await updateVideo(servers[0].url, servers[0].accessToken, video4UUID, { description: 'super description' })

      await waitJobs(servers)

      for (const server of servers) {
        const res = await getVideosList(server.url)
        expect(res.body.data.find(v => v.uuid === video4UUID)).to.be.undefined
      }
    })

    it('Should have the correct video blacklist unfederate attribute', async function () {
      const res = await getBlacklistedVideosList({ url: servers[0].url, token: servers[0].accessToken, sort: 'createdAt' })

      const blacklistedVideos: VideoBlacklist[] = res.body.data
      const video3Blacklisted = blacklistedVideos.find(b => b.video.uuid === video3UUID)
      const video4Blacklisted = blacklistedVideos.find(b => b.video.uuid === video4UUID)

      expect(video3Blacklisted.unfederated).to.be.false
      expect(video4Blacklisted.unfederated).to.be.true
    })

    it('Should remove the video from blacklist and refederate the video', async function () {
      this.timeout(10000)

      await removeVideoFromBlacklist(servers[0].url, servers[0].accessToken, video4UUID)

      await waitJobs(servers)

      for (const server of servers) {
        const res = await getVideosList(server.url)
        expect(res.body.data.find(v => v.uuid === video4UUID)).to.not.be.undefined
      }
    })

  })

  describe('When auto blacklist videos', function () {
    let userWithoutFlag: string
    let userWithFlag: string
    let channelOfUserWithoutFlag: number

    before(async function () {
      this.timeout(20000)

      killallServers([ servers[0] ])

      const config = {
        auto_blacklist: {
          videos: {
            of_users: {
              enabled: true
            }
          }
        }
      }
      await reRunServer(servers[0], config)

      {
        const user = { username: 'user_without_flag', password: 'password' }
        await createUser({
          url: servers[0].url,
          accessToken: servers[0].accessToken,
          username: user.username,
          adminFlags: UserAdminFlag.NONE,
          password: user.password,
          role: UserRole.USER
        })

        userWithoutFlag = await userLogin(servers[0], user)

        const res = await getMyUserInformation(servers[0].url, userWithoutFlag)
        const body: User = res.body
        channelOfUserWithoutFlag = body.videoChannels[0].id
      }

      {
        const user = { username: 'user_with_flag', password: 'password' }
        await createUser({
          url: servers[0].url,
          accessToken: servers[0].accessToken,
          username: user.username,
          adminFlags: UserAdminFlag.BY_PASS_VIDEO_AUTO_BLACKLIST,
          password: user.password,
          role: UserRole.USER
        })

        userWithFlag = await userLogin(servers[0], user)
      }

      await waitJobs(servers)
    })

    it('Should auto blacklist a video on upload', async function () {
      await uploadVideo(servers[0].url, userWithoutFlag, { name: 'blacklisted' })

      const res = await getBlacklistedVideosList({
        url: servers[0].url,
        token: servers[0].accessToken,
        type: VideoBlacklistType.AUTO_BEFORE_PUBLISHED
      })

      expect(res.body.total).to.equal(1)
      expect(res.body.data[0].video.name).to.equal('blacklisted')
    })

    it('Should auto blacklist a video on URL import', async function () {
      this.timeout(15000)

      const attributes = {
        targetUrl: getYoutubeVideoUrl(),
        name: 'URL import',
        channelId: channelOfUserWithoutFlag
      }
      await importVideo(servers[0].url, userWithoutFlag, attributes)

      const res = await getBlacklistedVideosList({
        url: servers[0].url,
        token: servers[0].accessToken,
        sort: 'createdAt',
        type: VideoBlacklistType.AUTO_BEFORE_PUBLISHED
      })

      expect(res.body.total).to.equal(2)
      expect(res.body.data[1].video.name).to.equal('URL import')
    })

    it('Should auto blacklist a video on torrent import', async function () {
      const attributes = {
        magnetUri: getMagnetURI(),
        name: 'Torrent import',
        channelId: channelOfUserWithoutFlag
      }
      await importVideo(servers[0].url, userWithoutFlag, attributes)

      const res = await getBlacklistedVideosList({
        url: servers[0].url,
        token: servers[0].accessToken,
        sort: 'createdAt',
        type: VideoBlacklistType.AUTO_BEFORE_PUBLISHED
      })

      expect(res.body.total).to.equal(3)
      expect(res.body.data[2].video.name).to.equal('Torrent import')
    })

    it('Should not auto blacklist a video on upload if the user has the bypass blacklist flag', async function () {
      await uploadVideo(servers[0].url, userWithFlag, { name: 'not blacklisted' })

      const res = await getBlacklistedVideosList({
        url: servers[0].url,
        token: servers[0].accessToken,
        type: VideoBlacklistType.AUTO_BEFORE_PUBLISHED
      })

      expect(res.body.total).to.equal(3)
    })
  })

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