shared/extra-utils/videos/videos.ts

   1 /* eslint-disable @typescript-eslint/no-unused-expressions,@typescript-eslint/no-floating-promises */
   2
   3 import { expect } from 'chai'
   4 import { pathExists, readdir } from 'fs-extra'
   5 import { basename, join } from 'path'
   6 import { getLowercaseExtension } from '@server/helpers/core-utils'
   7 import { uuidRegex } from '@shared/core-utils'
   8 import { HttpStatusCode, VideoCaption, VideoDetails } from '@shared/models'
   9 import { VIDEO_CATEGORIES, VIDEO_LANGUAGES, VIDEO_LICENCES, VIDEO_PRIVACIES } from '../../../server/initializers/constants'
  10 import { dateIsValid, testImage, webtorrentAdd } from '../miscs'
  11 import { makeRawRequest } from '../requests/requests'
  12 import { waitJobs } from '../server'
  13 import { PeerTubeServer } from '../server/server'
  14 import { VideoEdit } from './videos-command'
  15
  16 async function checkVideoFilesWereRemoved (options: {
  17   server: PeerTubeServer
  18   video: VideoDetails
  19   captions?: VideoCaption[]
  20   onlyVideoFiles?: boolean // default false
  21 }) {
  22   const { video, server, captions = [], onlyVideoFiles = false } = options
  23
  24   const webtorrentFiles = video.files || []
  25   const hlsFiles = video.streamingPlaylists[0]?.files || []
  26
  27   const thumbnailName = basename(video.thumbnailPath)
  28   const previewName = basename(video.previewPath)
  29
  30   const torrentNames = webtorrentFiles.concat(hlsFiles).map(f => basename(f.torrentUrl))
  31
  32   const captionNames = captions.map(c => basename(c.captionPath))
  33
  34   const webtorrentFilenames = webtorrentFiles.map(f => basename(f.fileUrl))
  35   const hlsFilenames = hlsFiles.map(f => basename(f.fileUrl))
  36
  37   let directories: { [ directory: string ]: string[] } = {
  38     videos: webtorrentFilenames,
  39     redundancy: webtorrentFilenames,
  40     [join('playlists', 'hls')]: hlsFilenames,
  41     [join('redundancy', 'hls')]: hlsFilenames
  42   }
  43
  44   if (onlyVideoFiles !== true) {
  45     directories = {
  46       ...directories,
  47
  48       thumbnails: [ thumbnailName ],
  49       previews: [ previewName ],
  50       torrents: torrentNames,
  51       captions: captionNames
  52     }
  53   }
  54
  55   for (const directory of Object.keys(directories)) {
  56     const directoryPath = server.servers.buildDirectory(directory)
  57
  58     const directoryExists = await pathExists(directoryPath)
  59     if (directoryExists === false) continue
  60
  61     const existingFiles = await readdir(directoryPath)
  62     for (const existingFile of existingFiles) {
  63       for (const shouldNotExist of directories[directory]) {
  64         expect(existingFile, `File ${existingFile} should not exist in ${directoryPath}`).to.not.contain(shouldNotExist)
  65       }
  66     }
  67   }
  68 }
  69
  70 async function saveVideoInServers (servers: PeerTubeServer[], uuid: string) {
  71   for (const server of servers) {
  72     server.store.videoDetails = await server.videos.get({ id: uuid })
  73   }
  74 }
  75
  76 function checkUploadVideoParam (
  77   server: PeerTubeServer,
  78   token: string,
  79   attributes: Partial<VideoEdit>,
  80   expectedStatus = HttpStatusCode.OK_200,
  81   mode: 'legacy' | 'resumable' = 'legacy'
  82 ) {
  83   return mode === 'legacy'
  84     ? server.videos.buildLegacyUpload({ token, attributes, expectedStatus })
  85     : server.videos.buildResumeUpload({ token, attributes, expectedStatus })
  86 }
  87
  88 async function completeVideoCheck (
  89   server: PeerTubeServer,
  90   video: any,
  91   attributes: {
  92     name: string
  93     category: number
  94     licence: number
  95     language: string
  96     nsfw: boolean
  97     commentsEnabled: boolean
  98     downloadEnabled: boolean
  99     description: string
 100     publishedAt?: string
 101     support: string
 102     originallyPublishedAt?: string
 103     account: {
 104       name: string
 105       host: string
 106     }
 107     isLocal: boolean
 108     tags: string[]
 109     privacy: number
 110     likes?: number
 111     dislikes?: number
 112     duration: number
 113     channel: {
 114       displayName: string
 115       name: string
 116       description: string
 117       isLocal: boolean
 118     }
 119     fixture: string
 120     files: {
 121       resolution: number
 122       size: number
 123     }[]
 124     thumbnailfile?: string
 125     previewfile?: string
 126   }
 127 ) {
 128   if (!attributes.likes) attributes.likes = 0
 129   if (!attributes.dislikes) attributes.dislikes = 0
 130
 131   const host = new URL(server.url).host
 132   const originHost = attributes.account.host
 133
 134   expect(video.name).to.equal(attributes.name)
 135   expect(video.category.id).to.equal(attributes.category)
 136   expect(video.category.label).to.equal(attributes.category !== null ? VIDEO_CATEGORIES[attributes.category] : 'Misc')
 137   expect(video.licence.id).to.equal(attributes.licence)
 138   expect(video.licence.label).to.equal(attributes.licence !== null ? VIDEO_LICENCES[attributes.licence] : 'Unknown')
 139   expect(video.language.id).to.equal(attributes.language)
 140   expect(video.language.label).to.equal(attributes.language !== null ? VIDEO_LANGUAGES[attributes.language] : 'Unknown')
 141   expect(video.privacy.id).to.deep.equal(attributes.privacy)
 142   expect(video.privacy.label).to.deep.equal(VIDEO_PRIVACIES[attributes.privacy])
 143   expect(video.nsfw).to.equal(attributes.nsfw)
 144   expect(video.description).to.equal(attributes.description)
 145   expect(video.account.id).to.be.a('number')
 146   expect(video.account.host).to.equal(attributes.account.host)
 147   expect(video.account.name).to.equal(attributes.account.name)
 148   expect(video.channel.displayName).to.equal(attributes.channel.displayName)
 149   expect(video.channel.name).to.equal(attributes.channel.name)
 150   expect(video.likes).to.equal(attributes.likes)
 151   expect(video.dislikes).to.equal(attributes.dislikes)
 152   expect(video.isLocal).to.equal(attributes.isLocal)
 153   expect(video.duration).to.equal(attributes.duration)
 154   expect(video.url).to.contain(originHost)
 155   expect(dateIsValid(video.createdAt)).to.be.true
 156   expect(dateIsValid(video.publishedAt)).to.be.true
 157   expect(dateIsValid(video.updatedAt)).to.be.true
 158
 159   if (attributes.publishedAt) {
 160     expect(video.publishedAt).to.equal(attributes.publishedAt)
 161   }
 162
 163   if (attributes.originallyPublishedAt) {
 164     expect(video.originallyPublishedAt).to.equal(attributes.originallyPublishedAt)
 165   } else {
 166     expect(video.originallyPublishedAt).to.be.null
 167   }
 168
 169   const videoDetails = await server.videos.get({ id: video.uuid })
 170
 171   expect(videoDetails.files).to.have.lengthOf(attributes.files.length)
 172   expect(videoDetails.tags).to.deep.equal(attributes.tags)
 173   expect(videoDetails.account.name).to.equal(attributes.account.name)
 174   expect(videoDetails.account.host).to.equal(attributes.account.host)
 175   expect(video.channel.displayName).to.equal(attributes.channel.displayName)
 176   expect(video.channel.name).to.equal(attributes.channel.name)
 177   expect(videoDetails.channel.host).to.equal(attributes.account.host)
 178   expect(videoDetails.channel.isLocal).to.equal(attributes.channel.isLocal)
 179   expect(dateIsValid(videoDetails.channel.createdAt.toString())).to.be.true
 180   expect(dateIsValid(videoDetails.channel.updatedAt.toString())).to.be.true
 181   expect(videoDetails.commentsEnabled).to.equal(attributes.commentsEnabled)
 182   expect(videoDetails.downloadEnabled).to.equal(attributes.downloadEnabled)
 183
 184   for (const attributeFile of attributes.files) {
 185     const file = videoDetails.files.find(f => f.resolution.id === attributeFile.resolution)
 186     expect(file).not.to.be.undefined
 187
 188     let extension = getLowercaseExtension(attributes.fixture)
 189     // Transcoding enabled: extension will always be .mp4
 190     if (attributes.files.length > 1) extension = '.mp4'
 191
 192     expect(file.magnetUri).to.have.lengthOf.above(2)
 193
 194     expect(file.torrentDownloadUrl).to.match(new RegExp(`http://${host}/download/torrents/${uuidRegex}-${file.resolution.id}.torrent`))
 195     expect(file.torrentUrl).to.match(new RegExp(`http://${host}/lazy-static/torrents/${uuidRegex}-${file.resolution.id}.torrent`))
 196
 197     expect(file.fileUrl).to.match(new RegExp(`http://${originHost}/static/webseed/${uuidRegex}-${file.resolution.id}${extension}`))
 198     expect(file.fileDownloadUrl).to.match(new RegExp(`http://${originHost}/download/videos/${uuidRegex}-${file.resolution.id}${extension}`))
 199
 200     await Promise.all([
 201       makeRawRequest(file.torrentUrl, 200),
 202       makeRawRequest(file.torrentDownloadUrl, 200),
 203       makeRawRequest(file.metadataUrl, 200)
 204     ])
 205
 206     expect(file.resolution.id).to.equal(attributeFile.resolution)
 207     expect(file.resolution.label).to.equal(attributeFile.resolution + 'p')
 208
 209     const minSize = attributeFile.size - ((10 * attributeFile.size) / 100)
 210     const maxSize = attributeFile.size + ((10 * attributeFile.size) / 100)
 211     expect(
 212       file.size,
 213       'File size for resolution ' + file.resolution.label + ' outside confidence interval (' + minSize + '> size <' + maxSize + ')'
 214     ).to.be.above(minSize).and.below(maxSize)
 215
 216     const torrent = await webtorrentAdd(file.magnetUri, true)
 217     expect(torrent.files).to.be.an('array')
 218     expect(torrent.files.length).to.equal(1)
 219     expect(torrent.files[0].path).to.exist.and.to.not.equal('')
 220     expect(torrent.files[0].name).to.equal(`${videoDetails.name} ${file.resolution.id}p${extension}`)
 221   }
 222
 223   expect(videoDetails.thumbnailPath).to.exist
 224   await testImage(server.url, attributes.thumbnailfile || attributes.fixture, videoDetails.thumbnailPath)
 225
 226   if (attributes.previewfile) {
 227     expect(videoDetails.previewPath).to.exist
 228     await testImage(server.url, attributes.previewfile, videoDetails.previewPath)
 229   }
 230 }
 231
 232 // serverNumber starts from 1
 233 async function uploadRandomVideoOnServers (
 234   servers: PeerTubeServer[],
 235   serverNumber: number,
 236   additionalParams?: VideoEdit & { prefixName?: string }
 237 ) {
 238   const server = servers.find(s => s.serverNumber === serverNumber)
 239   const res = await server.videos.randomUpload({ wait: false, additionalParams })
 240
 241   await waitJobs(servers)
 242
 243   return res
 244 }
 245
 246 // ---------------------------------------------------------------------------
 247
 248 export {
 249   checkUploadVideoParam,
 250   completeVideoCheck,
 251   uploadRandomVideoOnServers,
 252   checkVideoFilesWereRemoved,
 253   saveVideoInServers
 254 }