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 * as ffmpeg from 'fluent-ffmpeg'
   5 import { ensureDir, pathExists, readFile, stat } from 'fs-extra'
   6 import { basename, dirname, isAbsolute, join, resolve } from 'path'
   7 import * as request from 'supertest'
   8 import * as WebTorrent from 'webtorrent'
   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 (server: { internalServerNumber: number }, directory: string) {
  48   return join(root(), 'test' + server.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 && process.env.GITHUB_WORKSPACE) {
  70     return join(process.env.GITHUB_WORKSPACE, 'fixtures', path)
  71   }
  72
  73   return join(root(), 'server', 'tests', 'fixtures', path)
  74 }
  75
  76 function areHttpImportTestsDisabled () {
  77   const disabled = process.env.DISABLE_HTTP_IMPORT_TESTS === 'true'
  78
  79   if (disabled) console.log('Import tests are disabled')
  80
  81   return disabled
  82 }
  83
  84 async function generateHighBitrateVideo () {
  85   const tempFixturePath = buildAbsoluteFixturePath('video_high_bitrate_1080p.mp4', true)
  86
  87   await ensureDir(dirname(tempFixturePath))
  88
  89   const exists = await pathExists(tempFixturePath)
  90   if (!exists) {
  91     console.log('Generating high bitrate video.')
  92
  93     // Generate a random, high bitrate video on the fly, so we don't have to include
  94     // a large file in the repo. The video needs to have a certain minimum length so
  95     // that FFmpeg properly applies bitrate limits.
  96     // https://stackoverflow.com/a/15795112
  97     return new Promise<string>((res, rej) => {
  98       ffmpeg()
  99         .outputOptions([ '-f rawvideo', '-video_size 1920x1080', '-i /dev/urandom' ])
 100         .outputOptions([ '-ac 2', '-f s16le', '-i /dev/urandom', '-t 10' ])
 101         .outputOptions([ '-maxrate 10M', '-bufsize 10M' ])
 102         .output(tempFixturePath)
 103         .on('error', rej)
 104         .on('end', () => res(tempFixturePath))
 105         .run()
 106     })
 107   }
 108
 109   return tempFixturePath
 110 }
 111
 112 async function generateVideoWithFramerate (fps = 60) {
 113   const tempFixturePath = buildAbsoluteFixturePath(`video_${fps}fps.mp4`, true)
 114
 115   await ensureDir(dirname(tempFixturePath))
 116
 117   const exists = await pathExists(tempFixturePath)
 118   if (!exists) {
 119     console.log('Generating video with framerate %d.', fps)
 120
 121     return new Promise<string>((res, rej) => {
 122       ffmpeg()
 123         .outputOptions([ '-f rawvideo', '-video_size 1280x720', '-i /dev/urandom' ])
 124         .outputOptions([ '-ac 2', '-f s16le', '-i /dev/urandom', '-t 10' ])
 125         .outputOptions([ `-r ${fps}` ])
 126         .output(tempFixturePath)
 127         .on('error', rej)
 128         .on('end', () => res(tempFixturePath))
 129         .run()
 130     })
 131   }
 132
 133   return tempFixturePath
 134 }
 135
 136 async function getFileSize (path: string) {
 137   const stats = await stat(path)
 138
 139   return stats.size
 140 }
 141
 142 // ---------------------------------------------------------------------------
 143
 144 export {
 145   dateIsValid,
 146   wait,
 147   areHttpImportTestsDisabled,
 148   buildServerDirectory,
 149   webtorrentAdd,
 150   getFileSize,
 151   immutableAssign,
 152   testImage,
 153   buildAbsoluteFixturePath,
 154   root,
 155   generateHighBitrateVideo,
 156   generateVideoWithFramerate
 157 }