Merge branch 'move-utils-to-shared' of https://github.com/buoyantair/PeerTube into...
[oweals/peertube.git] / shared / utils / miscs / miscs.ts
1 /* tslint:disable:no-unused-expression */
2
3 import * as chai from 'chai'
4 import { isAbsolute, join } from 'path'
5 import * as request from 'supertest'
6 import * as WebTorrent from 'webtorrent'
7 import { pathExists, readFile } from 'fs-extra'
8 import * as ffmpeg from 'fluent-ffmpeg'
9
10 const expect = chai.expect
11 let webtorrent = new WebTorrent()
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   if (refreshWebTorrent === true) webtorrent = new WebTorrent()
31
32   return new Promise<WebTorrent.Torrent>(res => webtorrent.add(torrent, res))
33 }
34
35 function root () {
36   // We are in /shared/utils/miscs
37   return join(__dirname, '..', '..', '..')
38 }
39
40 async function testImage (url: string, imageName: string, imagePath: string, extension = '.jpg') {
41   const res = await request(url)
42     .get(imagePath)
43     .expect(200)
44
45   const body = res.body
46
47   const data = await readFile(join(root(), 'server', 'tests', 'fixtures', imageName + extension))
48   const minLength = body.length - ((20 * body.length) / 100)
49   const maxLength = body.length + ((20 * body.length) / 100)
50
51   expect(data.length).to.be.above(minLength)
52   expect(data.length).to.be.below(maxLength)
53 }
54
55 function buildAbsoluteFixturePath (path: string, customTravisPath = false) {
56   if (isAbsolute(path)) {
57     return path
58   }
59
60   if (customTravisPath && process.env.TRAVIS) return join(process.env.HOME, 'fixtures', path)
61
62   return join(root(), 'server', 'tests', 'fixtures', path)
63 }
64
65 async function generateHighBitrateVideo () {
66   const tempFixturePath = buildAbsoluteFixturePath('video_high_bitrate_1080p.mp4', true)
67
68   const exists = await pathExists(tempFixturePath)
69   if (!exists) {
70
71     // Generate a random, high bitrate video on the fly, so we don't have to include
72     // a large file in the repo. The video needs to have a certain minimum length so
73     // that FFmpeg properly applies bitrate limits.
74     // https://stackoverflow.com/a/15795112
75     return new Promise<string>(async (res, rej) => {
76       ffmpeg()
77         .outputOptions([ '-f rawvideo', '-video_size 1920x1080', '-i /dev/urandom' ])
78         .outputOptions([ '-ac 2', '-f s16le', '-i /dev/urandom', '-t 10' ])
79         .outputOptions([ '-maxrate 10M', '-bufsize 10M' ])
80         .output(tempFixturePath)
81         .on('error', rej)
82         .on('end', () => res(tempFixturePath))
83         .run()
84     })
85   }
86
87   return tempFixturePath
88 }
89
90 // ---------------------------------------------------------------------------
91
92 export {
93   dateIsValid,
94   wait,
95   webtorrentAdd,
96   immutableAssign,
97   testImage,
98   buildAbsoluteFixturePath,
99   root,
100   generateHighBitrateVideo
101 }