shared/extra-utils/miscs/miscs.ts

   1 /* eslint-disable @typescript-eslint/no-unused-expressions,@typescript-eslint/require-await */
   2
   3 import * as chai from 'chai'
   4 import { basename, dirname, isAbsolute, join, resolve } from 'path'
   5 import * as request from 'supertest'
   6 import * as WebTorrent from 'webtorrent'
   7 import { ensureDir, pathExists, readFile } from 'fs-extra'
   8 import * as ffmpeg from 'fluent-ffmpeg'
   9
  10 const expect = chai.expect
  11 let webtorrent: WebTorrent.Instance
  12
  13 function immutableAssign<T, U> (target: T, source: U) {
  14   return Object.assign<{}, T, U>({}, target, source)
  15 }
  16
  17 // Default interval -> 5 minutes
  18 function dateIsValid (dateString: string, interval = 300000) {
  19   const dateToCheck = new Date(dateString)
  20   const now = new Date()
  21
  22   return Math.abs(now.getTime() - dateToCheck.getTime()) <= interval
  23 }
  24
  25 function wait (milliseconds: number) {
  26   return new Promise(resolve => setTimeout(resolve, milliseconds))
  27 }
  28
  29 function webtorrentAdd (torrent: string, refreshWebTorrent = false) {
  30   const WebTorrent = require('webtorrent')
  31
  32   if (!webtorrent) webtorrent = new WebTorrent()
  33   if (refreshWebTorrent === true) webtorrent = new WebTorrent()
  34
  35   return new Promise<WebTorrent.Torrent>(res => webtorrent.add(torrent, res))
  36 }
  37
  38 function root () {
  39   // We are in /miscs
  40   let root = join(__dirname, '..', '..', '..')
  41
  42   if (basename(root) === 'dist') root = resolve(root, '..')
  43
  44   return root
  45 }
  46
  47 function buildServerDirectory (internalServerNumber: number, directory: string) {
  48   return join(root(), 'test' + internalServerNumber, directory)
  49 }
  50
  51 async function testImage (url: string, imageName: string, imagePath: string, extension = '.jpg') {
  52   const res = await request(url)
  53     .get(imagePath)
  54     .expect(200)
  55
  56   const body = res.body
  57
  58   const data = await readFile(join(root(), 'server', 'tests', 'fixtures', imageName + extension))
  59   const minLength = body.length - ((30 * body.length) / 100)
  60   const maxLength = body.length + ((30 * body.length) / 100)
  61
  62   expect(data.length).to.be.above(minLength, "the generated image is way smaller than the recorded fixture")
  63   expect(data.length).to.be.below(maxLength, "the generated image is way larger than the recorded fixture")
  64 }
  65
  66 function buildAbsoluteFixturePath (path: string, customCIPath = false) {
  67   if (isAbsolute(path)) return path
  68
  69   if (customCIPath) {
  70     if (process.env.GITLAB_CI) return join(root(), 'cached-fixtures', path)
  71
  72     return join(process.env.HOME, 'fixtures', path)
  73   }
  74
  75   return join(root(), 'server', 'tests', 'fixtures', path)
  76 }
  77
  78 function areHttpImportTestsDisabled () {
  79   const disabled = process.env.DISABLE_HTTP_IMPORT_TESTS === 'true'
  80
  81   if (disabled) console.log('Import tests are disabled')
  82
  83   return disabled
  84 }
  85
  86 async function generateHighBitrateVideo () {
  87   const tempFixturePath = buildAbsoluteFixturePath('video_high_bitrate_1080p.mp4', true)
  88
  89   await ensureDir(dirname(tempFixturePath))
  90
  91   const exists = await pathExists(tempFixturePath)
  92   if (!exists) {
  93
  94     // Generate a random, high bitrate video on the fly, so we don't have to include
  95     // a large file in the repo. The video needs to have a certain minimum length so
  96     // that FFmpeg properly applies bitrate limits.
  97     // https://stackoverflow.com/a/15795112
  98     return new Promise<string>((res, rej) => {
  99       ffmpeg()
 100         .outputOptions([ '-f rawvideo', '-video_size 1920x1080', '-i /dev/urandom' ])
 101         .outputOptions([ '-ac 2', '-f s16le', '-i /dev/urandom', '-t 10' ])
 102         .outputOptions([ '-maxrate 10M', '-bufsize 10M' ])
 103         .output(tempFixturePath)
 104         .on('error', rej)
 105         .on('end', () => res(tempFixturePath))
 106         .run()
 107     })
 108   }
 109
 110   return tempFixturePath
 111 }
 112
 113 async function generateVideoWithFramerate (fps = 60) {
 114   const tempFixturePath = buildAbsoluteFixturePath(`video_${fps}fps.mp4`, true)
 115
 116   await ensureDir(dirname(tempFixturePath))
 117
 118   const exists = await pathExists(tempFixturePath)
 119   if (!exists) {
 120     return new Promise<string>((res, rej) => {
 121       ffmpeg()
 122         .outputOptions([ '-f rawvideo', '-video_size 1280x720', '-i /dev/urandom' ])
 123         .outputOptions([ '-ac 2', '-f s16le', '-i /dev/urandom', '-t 10' ])
 124         .outputOptions([ `-r ${fps}` ])
 125         .output(tempFixturePath)
 126         .on('error', rej)
 127         .on('end', () => res(tempFixturePath))
 128         .run()
 129     })
 130   }
 131
 132   return tempFixturePath
 133 }
 134
 135 // ---------------------------------------------------------------------------
 136
 137 export {
 138   dateIsValid,
 139   wait,
 140   areHttpImportTestsDisabled,
 141   buildServerDirectory,
 142   webtorrentAdd,
 143   immutableAssign,
 144   testImage,
 145   buildAbsoluteFixturePath,
 146   root,
 147   generateHighBitrateVideo,
 148   generateVideoWithFramerate
 149 }