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>

2 files changed, 113 insertions, 38 deletions

diff --git a/server/tests/cli/create-import-video-file-job.ts b/server/tests/cli/create-import-video-file-job.ts
index bddcff5e7..9f1b57a2e 100644
--- a/server/tests/cli/create-import-video-file-job.ts
+++ b/server/tests/cli/create-import-video-file-job.ts
@@ -2,8 +2,19 @@
 
 import 'mocha'
 import * as chai from 'chai'
-import { cleanupTests, createMultipleServers, doubleFollow, PeerTubeServer, setAccessTokensToServers, waitJobs } from '@shared/extra-utils'
-import { VideoFile } from '@shared/models'
+import {
+  areObjectStorageTestsDisabled,
+  cleanupTests,
+  createMultipleServers,
+  doubleFollow,
+  expectStartWith,
+  makeRawRequest,
+  ObjectStorageCommand,
+  PeerTubeServer,
+  setAccessTokensToServers,
+  waitJobs
+} from '@shared/extra-utils'
+import { HttpStatusCode, VideoDetails, VideoFile } from '@shared/models'
 
 const expect = chai.expect
 
@@ -17,22 +28,35 @@ function assertVideoProperties (video: VideoFile, resolution: number, extname: s
   if (size) expect(video.size).to.equal(size)
 }
 
-describe('Test create import video jobs', function () {
-  this.timeout(60000)
+async function checkFiles (video: VideoDetails, objectStorage: boolean) {
+  for (const file of video.files) {
+    if (objectStorage) expectStartWith(file.fileUrl, ObjectStorageCommand.getWebTorrentBaseUrl())
 
-  let servers: PeerTubeServer[] = []
+    await makeRawRequest(file.fileUrl, HttpStatusCode.OK_200)
+  }
+}
+
+function runTests (objectStorage: boolean) {
   let video1UUID: string
   let video2UUID: string
 
+  let servers: PeerTubeServer[] = []
+
   before(async function () {
     this.timeout(90000)
 
+    const config = objectStorage
+      ? ObjectStorageCommand.getDefaultConfig()
+      : {}
+
     // Run server 2 to have transcoding enabled
-    servers = await createMultipleServers(2)
+    servers = await createMultipleServers(2, config)
     await setAccessTokensToServers(servers)
 
     await doubleFollow(servers[0], servers[1])
 
+    if (objectStorage) await ObjectStorageCommand.prepareDefaultBuckets()
+
     // Upload two videos for our needs
     {
       const { uuid } = await servers[0].videos.upload({ attributes: { name: 'video1' } })
@@ -44,7 +68,6 @@ describe('Test create import video jobs', function () {
       video2UUID = uuid
     }
 
-    // Transcoding
     await waitJobs(servers)
   })
 
@@ -65,6 +88,8 @@ describe('Test create import video jobs', function () {
       const [ originalVideo, transcodedVideo ] = videoDetails.files
       assertVideoProperties(originalVideo, 720, 'webm', 218910)
       assertVideoProperties(transcodedVideo, 480, 'webm', 69217)
+
+      await checkFiles(videoDetails, objectStorage)
     }
   })
 
@@ -87,6 +112,8 @@ describe('Test create import video jobs', function () {
       assertVideoProperties(transcodedVideo420, 480, 'mp4')
       assertVideoProperties(transcodedVideo320, 360, 'mp4')
       assertVideoProperties(transcodedVideo240, 240, 'mp4')
+
+      await checkFiles(videoDetails, objectStorage)
     }
   })
 
@@ -107,10 +134,25 @@ describe('Test create import video jobs', function () {
       const [ video720, video480 ] = videoDetails.files
       assertVideoProperties(video720, 720, 'webm', 942961)
       assertVideoProperties(video480, 480, 'webm', 69217)
+
+      await checkFiles(videoDetails, objectStorage)
     }
   })
 
   after(async function () {
     await cleanupTests(servers)
   })
+}
+
+describe('Test create import video jobs', function () {
+
+  describe('On filesystem', function () {
+    runTests(false)
+  })
+
+  describe('On object storage', function () {
+    if (areObjectStorageTestsDisabled()) return
+
+    runTests(true)
+  })
 })
diff --git a/server/tests/cli/create-transcoding-job.ts b/server/tests/cli/create-transcoding-job.ts
index df787ccdc..3313a492f 100644
--- a/server/tests/cli/create-transcoding-job.ts
+++ b/server/tests/cli/create-transcoding-job.ts
@@ -2,10 +2,15 @@
 
 import 'mocha'
 import * as chai from 'chai'
+import { HttpStatusCode, VideoFile } from '@shared/models'
 import {
+  areObjectStorageTestsDisabled,
   cleanupTests,
   createMultipleServers,
   doubleFollow,
+  expectStartWith,
+  makeRawRequest,
+  ObjectStorageCommand,
   PeerTubeServer,
   setAccessTokensToServers,
   waitJobs
@@ -13,39 +18,39 @@ import {
 
 const expect = chai.expect
 
-describe('Test create transcoding jobs', function () {
-  let servers: PeerTubeServer[] = []
-  const videosUUID: string[] = []
+async function checkFilesInObjectStorage (files: VideoFile[], type: 'webtorrent' | 'playlist') {
+  for (const file of files) {
+    const shouldStartWith = type === 'webtorrent'
+      ? ObjectStorageCommand.getWebTorrentBaseUrl()
+      : ObjectStorageCommand.getPlaylistBaseUrl()
 
-  const config = {
-    transcoding: {
-      enabled: false,
-      resolutions: {
-        '240p': true,
-        '360p': true,
-        '480p': true,
-        '720p': true,
-        '1080p': true,
-        '1440p': true,
-        '2160p': true
-      },
-      hls: {
-        enabled: false
-      }
-    }
+    expectStartWith(file.fileUrl, shouldStartWith)
+
+    await makeRawRequest(file.fileUrl, HttpStatusCode.OK_200)
   }
+}
+
+function runTests (objectStorage: boolean) {
+  let servers: PeerTubeServer[] = []
+  const videosUUID: string[] = []
 
   before(async function () {
     this.timeout(60000)
 
+    const config = objectStorage
+      ? ObjectStorageCommand.getDefaultConfig()
+      : {}
+
     // Run server 2 to have transcoding enabled
-    servers = await createMultipleServers(2)
+    servers = await createMultipleServers(2, config)
     await setAccessTokensToServers(servers)
 
-    await servers[0].config.updateCustomSubConfig({ newConfig: config })
+    await servers[0].config.disableTranscoding()
 
     await doubleFollow(servers[0], servers[1])
 
+    if (objectStorage) await ObjectStorageCommand.prepareDefaultBuckets()
+
     for (let i = 1; i <= 5; i++) {
       const { uuid } = await servers[0].videos.upload({ attributes: { name: 'video' + i } })
       videosUUID.push(uuid)
@@ -81,27 +86,29 @@ describe('Test create transcoding jobs', function () {
       let infoHashes: { [id: number]: string }
 
       for (const video of data) {
-        const videoDetail = await server.videos.get({ id: video.uuid })
+        const videoDetails = await server.videos.get({ id: video.uuid })
 
         if (video.uuid === videosUUID[1]) {
-          expect(videoDetail.files).to.have.lengthOf(4)
-          expect(videoDetail.streamingPlaylists).to.have.lengthOf(0)
+          expect(videoDetails.files).to.have.lengthOf(4)
+          expect(videoDetails.streamingPlaylists).to.have.lengthOf(0)
+
+          if (objectStorage) await checkFilesInObjectStorage(videoDetails.files, 'webtorrent')
 
           if (!infoHashes) {
             infoHashes = {}
 
-            for (const file of videoDetail.files) {
+            for (const file of videoDetails.files) {
               infoHashes[file.resolution.id.toString()] = file.magnetUri
             }
           } else {
             for (const resolution of Object.keys(infoHashes)) {
-              const file = videoDetail.files.find(f => f.resolution.id.toString() === resolution)
+              const file = videoDetails.files.find(f => f.resolution.id.toString() === resolution)
               expect(file.magnetUri).to.equal(infoHashes[resolution])
             }
           }
         } else {
-          expect(videoDetail.files).to.have.lengthOf(1)
-          expect(videoDetail.streamingPlaylists).to.have.lengthOf(0)
+          expect(videoDetails.files).to.have.lengthOf(1)
+          expect(videoDetails.streamingPlaylists).to.have.lengthOf(0)
         }
       }
     }
@@ -125,6 +132,8 @@ describe('Test create transcoding jobs', function () {
       expect(videoDetails.files[1].resolution.id).to.equal(480)
 
       expect(videoDetails.streamingPlaylists).to.have.lengthOf(0)
+
+      if (objectStorage) await checkFilesInObjectStorage(videoDetails.files, 'webtorrent')
     }
   })
 
@@ -139,11 +148,15 @@ describe('Test create transcoding jobs', function () {
       const videoDetails = await server.videos.get({ id: videosUUID[2] })
 
       expect(videoDetails.files).to.have.lengthOf(1)
+      if (objectStorage) await checkFilesInObjectStorage(videoDetails.files, 'webtorrent')
+
       expect(videoDetails.streamingPlaylists).to.have.lengthOf(1)
 
       const files = videoDetails.streamingPlaylists[0].files
       expect(files).to.have.lengthOf(1)
       expect(files[0].resolution.id).to.equal(480)
+
+      if (objectStorage) await checkFilesInObjectStorage(files, 'playlist')
     }
   })
 
@@ -160,6 +173,8 @@ describe('Test create transcoding jobs', function () {
       const files = videoDetails.streamingPlaylists[0].files
       expect(files).to.have.lengthOf(1)
       expect(files[0].resolution.id).to.equal(480)
+
+      if (objectStorage) await checkFilesInObjectStorage(files, 'playlist')
     }
   })
 
@@ -178,15 +193,15 @@ describe('Test create transcoding jobs', function () {
 
       const files = videoDetails.streamingPlaylists[0].files
       expect(files).to.have.lengthOf(4)
+
+      if (objectStorage) await checkFilesInObjectStorage(files, 'playlist')
     }
   })
 
   it('Should optimize the video file and generate HLS videos if enabled in config', async function () {
     this.timeout(120000)
 
-    config.transcoding.hls.enabled = true
-    await servers[0].config.updateCustomSubConfig({ newConfig: config })
-
+    await servers[0].config.enableTranscoding()
     await servers[0].cli.execWithEnv(`npm run create-transcoding-job -- -v ${videosUUID[4]}`)
 
     await waitJobs(servers)
@@ -197,10 +212,28 @@ describe('Test create transcoding jobs', function () {
       expect(videoDetails.files).to.have.lengthOf(4)
       expect(videoDetails.streamingPlaylists).to.have.lengthOf(1)
       expect(videoDetails.streamingPlaylists[0].files).to.have.lengthOf(4)
+
+      if (objectStorage) {
+        await checkFilesInObjectStorage(videoDetails.files, 'webtorrent')
+        await checkFilesInObjectStorage(videoDetails.streamingPlaylists[0].files, 'playlist')
+      }
     }
   })
 
   after(async function () {
     await cleanupTests(servers)
   })
+}
+
+describe('Test create transcoding jobs', function () {
+
+  describe('On filesystem', function () {
+    runTests(false)
+  })
+
+  describe('On object storage', function () {
+    if (areObjectStorageTestsDisabled()) return
+
+    runTests(true)
+  })
 })