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, 139 insertions, 0 deletions

diff --git a/server/lib/video-path-manager.ts b/server/lib/video-path-manager.ts
new file mode 100644
index 000000000..4c5d0c89d
--- /dev/null
+++ b/server/lib/video-path-manager.ts
@@ -0,0 +1,139 @@
+import { remove } from 'fs-extra'
+import { extname, join } from 'path'
+import { buildUUID } from '@server/helpers/uuid'
+import { extractVideo } from '@server/helpers/video'
+import { CONFIG } from '@server/initializers/config'
+import { MStreamingPlaylistVideo, MVideo, MVideoFile, MVideoUUID } from '@server/types/models'
+import { VideoStorage } from '@shared/models'
+import { makeHLSFileAvailable, makeWebTorrentFileAvailable } from './object-storage'
+import { getHLSDirectory, getHLSRedundancyDirectory, getHlsResolutionPlaylistFilename } from './paths'
+
+type MakeAvailableCB <T> = (path: string) => Promise<T> | T
+
+class VideoPathManager {
+
+  private static instance: VideoPathManager
+
+  private constructor () {}
+
+  getFSHLSOutputPath (video: MVideoUUID, filename?: string) {
+    const base = getHLSDirectory(video)
+    if (!filename) return base
+
+    return join(base, filename)
+  }
+
+  getFSRedundancyVideoFilePath (videoOrPlaylist: MVideo | MStreamingPlaylistVideo, videoFile: MVideoFile) {
+    if (videoFile.isHLS()) {
+      const video = extractVideo(videoOrPlaylist)
+
+      return join(getHLSRedundancyDirectory(video), videoFile.filename)
+    }
+
+    return join(CONFIG.STORAGE.REDUNDANCY_DIR, videoFile.filename)
+  }
+
+  getFSVideoFileOutputPath (videoOrPlaylist: MVideo | MStreamingPlaylistVideo, videoFile: MVideoFile) {
+    if (videoFile.isHLS()) {
+      const video = extractVideo(videoOrPlaylist)
+
+      return join(getHLSDirectory(video), videoFile.filename)
+    }
+
+    return join(CONFIG.STORAGE.VIDEOS_DIR, videoFile.filename)
+  }
+
+  async makeAvailableVideoFile <T> (videoOrPlaylist: MVideo | MStreamingPlaylistVideo, videoFile: MVideoFile, cb: MakeAvailableCB<T>) {
+    if (videoFile.storage === VideoStorage.FILE_SYSTEM) {
+      return this.makeAvailableFactory(
+        () => this.getFSVideoFileOutputPath(videoOrPlaylist, videoFile),
+        false,
+        cb
+      )
+    }
+
+    const destination = this.buildTMPDestination(videoFile.filename)
+
+    if (videoFile.isHLS()) {
+      const video = extractVideo(videoOrPlaylist)
+
+      return this.makeAvailableFactory(
+        () => makeHLSFileAvailable(videoOrPlaylist as MStreamingPlaylistVideo, video, videoFile.filename, destination),
+        true,
+        cb
+      )
+    }
+
+    return this.makeAvailableFactory(
+      () => makeWebTorrentFileAvailable(videoFile.filename, destination),
+      true,
+      cb
+    )
+  }
+
+  async makeAvailableResolutionPlaylistFile <T> (playlist: MStreamingPlaylistVideo, videoFile: MVideoFile, cb: MakeAvailableCB<T>) {
+    const filename = getHlsResolutionPlaylistFilename(videoFile.filename)
+
+    if (videoFile.storage === VideoStorage.FILE_SYSTEM) {
+      return this.makeAvailableFactory(
+        () => join(getHLSDirectory(playlist.Video), filename),
+        false,
+        cb
+      )
+    }
+
+    return this.makeAvailableFactory(
+      () => makeHLSFileAvailable(playlist, playlist.Video, filename, this.buildTMPDestination(filename)),
+      true,
+      cb
+    )
+  }
+
+  async makeAvailablePlaylistFile <T> (playlist: MStreamingPlaylistVideo, filename: string, cb: MakeAvailableCB<T>) {
+    if (playlist.storage === VideoStorage.FILE_SYSTEM) {
+      return this.makeAvailableFactory(
+        () => join(getHLSDirectory(playlist.Video), filename),
+        false,
+        cb
+      )
+    }
+
+    return this.makeAvailableFactory(
+      () => makeHLSFileAvailable(playlist, playlist.Video, filename, this.buildTMPDestination(filename)),
+      true,
+      cb
+    )
+  }
+
+  private async makeAvailableFactory <T> (method: () => Promise<string> | string, clean: boolean, cb: MakeAvailableCB<T>) {
+    let result: T
+
+    const destination = await method()
+
+    try {
+      result = await cb(destination)
+    } catch (err) {
+      if (destination && clean) await remove(destination)
+      throw err
+    }
+
+    if (clean) await remove(destination)
+
+    return result
+  }
+
+  private buildTMPDestination (filename: string) {
+    return join(CONFIG.STORAGE.TMP_DIR, buildUUID() + extname(filename))
+
+  }
+
+  static get Instance () {
+    return this.instance || (this.instance = new this())
+  }
+}
+
+// ---------------------------------------------------------------------------
+
+export {
+  VideoPathManager
+}