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>

7 files changed, 183 insertions, 5 deletions

diff --git a/shared/extra-utils/server/config-command.ts b/shared/extra-utils/server/config-command.ts
index 11148aa46..51d04fa63 100644
--- a/shared/extra-utils/server/config-command.ts
+++ b/shared/extra-utils/server/config-command.ts
@@ -18,6 +18,70 @@ export class ConfigCommand extends AbstractCommand {
     }
   }
 
+  enableImports () {
+    return this.updateExistingSubConfig({
+      newConfig: {
+        import: {
+          videos: {
+            http: {
+              enabled: true
+            },
+
+            torrent: {
+              enabled: true
+            }
+          }
+        }
+      }
+    })
+  }
+
+  enableLive (options: {
+    allowReplay?: boolean
+    transcoding?: boolean
+  } = {}) {
+    return this.updateExistingSubConfig({
+      newConfig: {
+        live: {
+          enabled: true,
+          allowReplay: options.allowReplay ?? true,
+          transcoding: {
+            enabled: options.transcoding ?? true,
+            resolutions: ConfigCommand.getCustomConfigResolutions(true)
+          }
+        }
+      }
+    })
+  }
+
+  disableTranscoding () {
+    return this.updateExistingSubConfig({
+      newConfig: {
+        transcoding: {
+          enabled: false
+        }
+      }
+    })
+  }
+
+  enableTranscoding (webtorrent = true, hls = true) {
+    return this.updateExistingSubConfig({
+      newConfig: {
+        transcoding: {
+          enabled: true,
+          resolutions: ConfigCommand.getCustomConfigResolutions(true),
+
+          webtorrent: {
+            enabled: webtorrent
+          },
+          hls: {
+            enabled: hls
+          }
+        }
+      }
+    })
+  }
+
   getConfig (options: OverrideCommandOptions = {}) {
     const path = '/api/v1/config'
 
@@ -81,6 +145,14 @@ export class ConfigCommand extends AbstractCommand {
     })
   }
 
+  async updateExistingSubConfig (options: OverrideCommandOptions & {
+    newConfig: DeepPartial<CustomConfig>
+  }) {
+    const existing = await this.getCustomConfig(options)
+
+    return this.updateCustomConfig({ ...options, newCustomConfig: merge({}, existing, options.newConfig) })
+  }
+
   updateCustomSubConfig (options: OverrideCommandOptions & {
     newConfig: DeepPartial<CustomConfig>
   }) {
diff --git a/shared/extra-utils/server/index.ts b/shared/extra-utils/server/index.ts
index 9055dfc57..92ff7a0f9 100644
--- a/shared/extra-utils/server/index.ts
+++ b/shared/extra-utils/server/index.ts
@@ -6,6 +6,7 @@ export * from './follows-command'
 export * from './follows'
 export * from './jobs'
 export * from './jobs-command'
+export * from './object-storage-command'
 export * from './plugins-command'
 export * from './plugins'
 export * from './redundancy-command'
diff --git a/shared/extra-utils/server/jobs-command.ts b/shared/extra-utils/server/jobs-command.ts
index c4eb12dc2..91771c176 100644
--- a/shared/extra-utils/server/jobs-command.ts
+++ b/shared/extra-utils/server/jobs-command.ts
@@ -5,6 +5,16 @@ import { AbstractCommand, OverrideCommandOptions } from '../shared'
 
 export class JobsCommand extends AbstractCommand {
 
+  async getLatest (options: OverrideCommandOptions & {
+    jobType: JobType
+  }) {
+    const { data } = await this.getJobsList({ ...options, start: 0, count: 1, sort: '-createdAt' })
+
+    if (data.length === 0) return undefined
+
+    return data[0]
+  }
+
   getJobsList (options: OverrideCommandOptions & {
     state?: JobState
     jobType?: JobType
diff --git a/shared/extra-utils/server/jobs.ts b/shared/extra-utils/server/jobs.ts
index 64a0353eb..27104bfdf 100644
--- a/shared/extra-utils/server/jobs.ts
+++ b/shared/extra-utils/server/jobs.ts
@@ -3,7 +3,7 @@ import { JobState } from '../../models'
 import { wait } from '../miscs'
 import { PeerTubeServer } from './server'
 
-async function waitJobs (serversArg: PeerTubeServer[] | PeerTubeServer) {
+async function waitJobs (serversArg: PeerTubeServer[] | PeerTubeServer, skipDelayed = false) {
   const pendingJobWait = process.env.NODE_PENDING_JOB_WAIT
     ? parseInt(process.env.NODE_PENDING_JOB_WAIT, 10)
     : 250
@@ -13,7 +13,9 @@ async function waitJobs (serversArg: PeerTubeServer[] | PeerTubeServer) {
   if (Array.isArray(serversArg) === false) servers = [ serversArg as PeerTubeServer ]
   else servers = serversArg as PeerTubeServer[]
 
-  const states: JobState[] = [ 'waiting', 'active', 'delayed' ]
+  const states: JobState[] = [ 'waiting', 'active' ]
+  if (!skipDelayed) states.push('delayed')
+
   const repeatableJobs = [ 'videos-views', 'activitypub-cleaner' ]
   let pendingRequests: boolean
 
diff --git a/shared/extra-utils/server/object-storage-command.ts b/shared/extra-utils/server/object-storage-command.ts
new file mode 100644
index 000000000..b4de8f4cb
--- /dev/null
+++ b/shared/extra-utils/server/object-storage-command.ts
@@ -0,0 +1,77 @@
+
+import { HttpStatusCode } from '@shared/models'
+import { makePostBodyRequest } from '../requests'
+import { AbstractCommand } from '../shared'
+
+export class ObjectStorageCommand extends AbstractCommand {
+  static readonly DEFAULT_PLAYLIST_BUCKET = 'streaming-playlists'
+  static readonly DEFAULT_WEBTORRENT_BUCKET = 'videos'
+
+  static getDefaultConfig () {
+    return {
+      object_storage: {
+        enabled: true,
+        endpoint: 'http://' + this.getEndpointHost(),
+        region: this.getRegion(),
+
+        credentials: this.getCredentialsConfig(),
+
+        streaming_playlists: {
+          bucket_name: this.DEFAULT_PLAYLIST_BUCKET
+        },
+
+        videos: {
+          bucket_name: this.DEFAULT_WEBTORRENT_BUCKET
+        }
+      }
+    }
+  }
+
+  static getCredentialsConfig () {
+    return {
+      access_key_id: 'AKIAIOSFODNN7EXAMPLE',
+      secret_access_key: 'wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY'
+    }
+  }
+
+  static getEndpointHost () {
+    return 'localhost:9444'
+  }
+
+  static getRegion () {
+    return 'us-east-1'
+  }
+
+  static getWebTorrentBaseUrl () {
+    return `http://${this.DEFAULT_WEBTORRENT_BUCKET}.${this.getEndpointHost()}/`
+  }
+
+  static getPlaylistBaseUrl () {
+    return `http://${this.DEFAULT_PLAYLIST_BUCKET}.${this.getEndpointHost()}/`
+  }
+
+  static async prepareDefaultBuckets () {
+    await this.createBucket(this.DEFAULT_PLAYLIST_BUCKET)
+    await this.createBucket(this.DEFAULT_WEBTORRENT_BUCKET)
+  }
+
+  static async createBucket (name: string) {
+    await makePostBodyRequest({
+      url: this.getEndpointHost(),
+      path: '/ui/' + name + '?delete',
+      expectedStatus: HttpStatusCode.TEMPORARY_REDIRECT_307
+    })
+
+    await makePostBodyRequest({
+      url: this.getEndpointHost(),
+      path: '/ui/' + name + '?create',
+      expectedStatus: HttpStatusCode.TEMPORARY_REDIRECT_307
+    })
+
+    await makePostBodyRequest({
+      url: this.getEndpointHost(),
+      path: '/ui/' + name + '?make-public',
+      expectedStatus: HttpStatusCode.TEMPORARY_REDIRECT_307
+    })
+  }
+}
diff --git a/shared/extra-utils/server/server.ts b/shared/extra-utils/server/server.ts
index 3c335b8e4..bc5e1cd5f 100644
--- a/shared/extra-utils/server/server.ts
+++ b/shared/extra-utils/server/server.ts
@@ -38,11 +38,13 @@ import { PluginsCommand } from './plugins-command'
 import { RedundancyCommand } from './redundancy-command'
 import { ServersCommand } from './servers-command'
 import { StatsCommand } from './stats-command'
+import { ObjectStorageCommand } from './object-storage-command'
 
 export type RunServerOptions = {
   hideLogs?: boolean
   nodeArgs?: string[]
   peertubeArgs?: string[]
+  env?: { [ id: string ]: string }
 }
 
 export class PeerTubeServer {
@@ -121,6 +123,7 @@ export class PeerTubeServer {
   servers?: ServersCommand
   login?: LoginCommand
   users?: UsersCommand
+  objectStorage?: ObjectStorageCommand
   videos?: VideosCommand
 
   constructor (options: { serverNumber: number } | { url: string }) {
@@ -202,6 +205,10 @@ export class PeerTubeServer {
     env['NODE_APP_INSTANCE'] = this.internalServerNumber.toString()
     env['NODE_CONFIG'] = JSON.stringify(configOverride)
 
+    if (options.env) {
+      Object.assign(env, options.env)
+    }
+
     const forkOptions = {
       silent: true,
       env,
@@ -209,10 +216,17 @@ export class PeerTubeServer {
       execArgv: options.nodeArgs || []
     }
 
-    return new Promise<void>(res => {
+    return new Promise<void>((res, rej) => {
       const self = this
 
       this.app = fork(join(root(), 'dist', 'server.js'), options.peertubeArgs || [], forkOptions)
+
+      const onExit = function () {
+        return rej(new Error('Process exited'))
+      }
+
+      this.app.on('exit', onExit)
+
       this.app.stdout.on('data', function onStdout (data) {
         let dontContinue = false
 
@@ -241,6 +255,7 @@ export class PeerTubeServer {
           console.log(data.toString())
         } else {
           self.app.stdout.removeListener('data', onStdout)
+          self.app.removeListener('exit', onExit)
         }
 
         process.on('exit', () => {
@@ -365,5 +380,6 @@ export class PeerTubeServer {
     this.login = new LoginCommand(this)
     this.users = new UsersCommand(this)
     this.videos = new VideosCommand(this)
+    this.objectStorage = new ObjectStorageCommand(this)
   }
 }
diff --git a/shared/extra-utils/server/servers.ts b/shared/extra-utils/server/servers.ts
index f0622feb0..21ab9405b 100644
--- a/shared/extra-utils/server/servers.ts
+++ b/shared/extra-utils/server/servers.ts
@@ -10,11 +10,11 @@ async function createSingleServer (serverNumber: number, configOverride?: Object
   return server
 }
 
-function createMultipleServers (totalServers: number, configOverride?: Object) {
+function createMultipleServers (totalServers: number, configOverride?: Object, options: RunServerOptions = {}) {
   const serverPromises: Promise<PeerTubeServer>[] = []
 
   for (let i = 1; i <= totalServers; i++) {
-    serverPromises.push(createSingleServer(i, configOverride))
+    serverPromises.push(createSingleServer(i, configOverride, options))
   }
 
   return Promise.all(serverPromises)