Add support for saving video files to object storage (#4290)

* Add support for saving video files to object storage

* Add support for custom url generation on s3 stored files

Uses two config keys to support url generation that doesn't directly go
to (compatible s3). Can be used to generate urls to any cache server or
CDN.

* Upload files to s3 concurrently and delete originals afterwards

* Only publish after move to object storage is complete

* Use base url instead of url template

* Fix mistyped config field

* Add rudenmentary way to download before transcode

* Implement Chocobozzz suggestions

https://github.com/Chocobozzz/PeerTube/pull/4290#issuecomment-891670478

The remarks in question:
    Try to use objectStorage prefix instead of s3 prefix for your function/variables/config names
    Prefer to use a tree for the config: s3.streaming_playlists_bucket -> object_storage.streaming_playlists.bucket
    Use uppercase for config: S3.STREAMING_PLAYLISTS_BUCKETINFO.bucket -> OBJECT_STORAGE.STREAMING_PLAYLISTS.BUCKET (maybe BUCKET_NAME instead of BUCKET)
    I suggest to rename moveJobsRunning to pendingMovingJobs (or better, create a dedicated videoJobInfo table with a pendingMove & videoId columns so we could also use this table to track pending transcoding jobs)
    https://github.com/Chocobozzz/PeerTube/pull/4290/files#diff-3e26d41ca4bda1de8e1747af70ca2af642abcc1e9e0bfb94239ff2165acfbde5R19 uses a string instead of an integer
    I think we should store the origin object storage URL in fileUrl, without base_url injection. Instead, inject the base_url at "runtime" so admins can easily change this configuration without running a script to update DB URLs

* Import correct function

* Support multipart upload

* Remove import of node 15.0 module stream/promises

* Extend maximum upload job length

Using the same value as for redundancy downloading seems logical

* Use dynamic part size for really large uploads

Also adds very small part size for local testing

* Fix decreasePendingMove query

* Resolve various PR comments

* Move to object storage after optimize

* Make upload size configurable and increase default

* Prune webtorrent files that are stored in object storage

* Move files after transcoding jobs

* Fix federation

* Add video path manager

* Support move to external storage job in client

* Fix live object storage tests

Co-authored-by: Chocobozzz <me@florianbigard.com>

1 files changed, 37 insertions, 45 deletions

diff --git a/server/lib/hls.ts b/server/lib/hls.ts
index 0e77ab9fa..0828a2d0f 100644
--- a/server/lib/hls.ts
+++ b/server/lib/hls.ts
@@ -1,4 +1,4 @@
-import { close, ensureDir, move, open, outputJSON, pathExists, read, readFile, remove, stat, writeFile } from 'fs-extra'
+import { close, ensureDir, move, open, outputJSON, read, readFile, remove, stat, writeFile } from 'fs-extra'
 import { flatten, uniq } from 'lodash'
 import { basename, dirname, join } from 'path'
 import { MStreamingPlaylistFilesVideo, MVideoWithFile } from '@server/types/models'
@@ -8,11 +8,12 @@ import { logger } from '../helpers/logger'
 import { doRequest, doRequestAndSaveToFile } from '../helpers/requests'
 import { generateRandomString } from '../helpers/utils'
 import { CONFIG } from '../initializers/config'
-import { HLS_STREAMING_PLAYLIST_DIRECTORY, P2P_MEDIA_LOADER_PEER_VERSION } from '../initializers/constants'
+import { P2P_MEDIA_LOADER_PEER_VERSION } from '../initializers/constants'
 import { sequelizeTypescript } from '../initializers/database'
 import { VideoFileModel } from '../models/video/video-file'
 import { VideoStreamingPlaylistModel } from '../models/video/video-streaming-playlist'
-import { getHlsResolutionPlaylistFilename, getVideoFilePath } from './video-paths'
+import { getHlsResolutionPlaylistFilename } from './paths'
+import { VideoPathManager } from './video-path-manager'
 
 async function updateStreamingPlaylistsInfohashesIfNeeded () {
   const playlistsToUpdate = await VideoStreamingPlaylistModel.listByIncorrectPeerVersion()
@@ -31,75 +32,66 @@ async function updateStreamingPlaylistsInfohashesIfNeeded () {
 }
 
 async function updateMasterHLSPlaylist (video: MVideoWithFile, playlist: MStreamingPlaylistFilesVideo) {
-  const directory = join(HLS_STREAMING_PLAYLIST_DIRECTORY, video.uuid)
-
   const masterPlaylists: string[] = [ '#EXTM3U', '#EXT-X-VERSION:3' ]
 
-  const masterPlaylistPath = join(directory, playlist.playlistFilename)
-
   for (const file of playlist.VideoFiles) {
     const playlistFilename = getHlsResolutionPlaylistFilename(file.filename)
 
-    // If we did not generated a playlist for this resolution, skip
-    const filePlaylistPath = join(directory, playlistFilename)
-    if (await pathExists(filePlaylistPath) === false) continue
-
-    const videoFilePath = getVideoFilePath(playlist, file)
+    await VideoPathManager.Instance.makeAvailableVideoFile(playlist, file, async videoFilePath => {
+      const size = await getVideoStreamSize(videoFilePath)
 
-    const size = await getVideoStreamSize(videoFilePath)
+      const bandwidth = 'BANDWIDTH=' + video.getBandwidthBits(file)
+      const resolution = `RESOLUTION=${size.width}x${size.height}`
 
-    const bandwidth = 'BANDWIDTH=' + video.getBandwidthBits(file)
-    const resolution = `RESOLUTION=${size.width}x${size.height}`
+      let line = `#EXT-X-STREAM-INF:${bandwidth},${resolution}`
+      if (file.fps) line += ',FRAME-RATE=' + file.fps
 
-    let line = `#EXT-X-STREAM-INF:${bandwidth},${resolution}`
-    if (file.fps) line += ',FRAME-RATE=' + file.fps
+      const codecs = await Promise.all([
+        getVideoStreamCodec(videoFilePath),
+        getAudioStreamCodec(videoFilePath)
+      ])
 
-    const codecs = await Promise.all([
-      getVideoStreamCodec(videoFilePath),
-      getAudioStreamCodec(videoFilePath)
-    ])
+      line += `,CODECS="${codecs.filter(c => !!c).join(',')}"`
 
-    line += `,CODECS="${codecs.filter(c => !!c).join(',')}"`
-
-    masterPlaylists.push(line)
-    masterPlaylists.push(playlistFilename)
+      masterPlaylists.push(line)
+      masterPlaylists.push(playlistFilename)
+    })
   }
 
-  await writeFile(masterPlaylistPath, masterPlaylists.join('\n') + '\n')
+  await VideoPathManager.Instance.makeAvailablePlaylistFile(playlist, playlist.playlistFilename, masterPlaylistPath => {
+    return writeFile(masterPlaylistPath, masterPlaylists.join('\n') + '\n')
+  })
 }
 
 async function updateSha256VODSegments (video: MVideoWithFile, playlist: MStreamingPlaylistFilesVideo) {
   const json: { [filename: string]: { [range: string]: string } } = {}
 
-  const playlistDirectory = join(HLS_STREAMING_PLAYLIST_DIRECTORY, video.uuid)
-
   // For all the resolutions available for this video
   for (const file of playlist.VideoFiles) {
     const rangeHashes: { [range: string]: string } = {}
 
-    const videoPath = getVideoFilePath(playlist, file)
-    const resolutionPlaylistPath = join(playlistDirectory, getHlsResolutionPlaylistFilename(file.filename))
-
-    // Maybe the playlist is not generated for this resolution yet
-    if (!await pathExists(resolutionPlaylistPath)) continue
+    await VideoPathManager.Instance.makeAvailableVideoFile(playlist, file, videoPath => {
 
-    const playlistContent = await readFile(resolutionPlaylistPath)
-    const ranges = getRangesFromPlaylist(playlistContent.toString())
+      return VideoPathManager.Instance.makeAvailableResolutionPlaylistFile(playlist, file, async resolutionPlaylistPath => {
+        const playlistContent = await readFile(resolutionPlaylistPath)
+        const ranges = getRangesFromPlaylist(playlistContent.toString())
 
-    const fd = await open(videoPath, 'r')
-    for (const range of ranges) {
-      const buf = Buffer.alloc(range.length)
-      await read(fd, buf, 0, range.length, range.offset)
+        const fd = await open(videoPath, 'r')
+        for (const range of ranges) {
+          const buf = Buffer.alloc(range.length)
+          await read(fd, buf, 0, range.length, range.offset)
 
-      rangeHashes[`${range.offset}-${range.offset + range.length - 1}`] = sha256(buf)
-    }
-    await close(fd)
+          rangeHashes[`${range.offset}-${range.offset + range.length - 1}`] = sha256(buf)
+        }
+        await close(fd)
 
-    const videoFilename = file.filename
-    json[videoFilename] = rangeHashes
+        const videoFilename = file.filename
+        json[videoFilename] = rangeHashes
+      })
+    })
   }
 
-  const outputPath = join(playlistDirectory, playlist.segmentsSha256Filename)
+  const outputPath = VideoPathManager.Instance.getFSHLSOutputPath(video, playlist.segmentsSha256Filename)
   await outputJSON(outputPath, json)
 }