]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blobdiff - server/lib/schedulers/videos-redundancy-scheduler.ts
More robust webtorrent redundancy download
[github/Chocobozzz/PeerTube.git] / server / lib / schedulers / videos-redundancy-scheduler.ts
index 0b1ae76ff853d74c06f5a6844e74275083d40f71..155d43343858bc131df063c680e4a3e827dffe1a 100644 (file)
@@ -1,22 +1,49 @@
-import { AbstractScheduler } from './abstract-scheduler'
-import { CONFIG, REDUNDANCY, VIDEO_IMPORT_TIMEOUT } from '../../initializers'
-import { logger } from '../../helpers/logger'
-import { VideosRedundancy } from '../../../shared/models/redundancy'
-import { VideoRedundancyModel } from '../../models/redundancy/video-redundancy'
-import { VideoFileModel } from '../../models/video/video-file'
-import { downloadWebTorrentVideo } from '../../helpers/webtorrent'
+import { move } from 'fs-extra'
 import { join } from 'path'
-import { rename } from 'fs-extra'
-import { getServerActor } from '../../helpers/utils'
+import { getServerActor } from '@server/models/application/application'
+import { VideoModel } from '@server/models/video/video'
+import {
+  MStreamingPlaylistFiles,
+  MVideoAccountLight,
+  MVideoFile,
+  MVideoFileVideo,
+  MVideoRedundancyFileVideo,
+  MVideoRedundancyStreamingPlaylistVideo,
+  MVideoRedundancyVideo,
+  MVideoWithAllFiles
+} from '@server/types/models'
+import { VideosRedundancyStrategy } from '../../../shared/models/redundancy'
+import { logger, loggerTagsFactory } from '../../helpers/logger'
+import { downloadWebTorrentVideo } from '../../helpers/webtorrent'
+import { CONFIG } from '../../initializers/config'
+import { HLS_REDUNDANCY_DIRECTORY, REDUNDANCY, VIDEO_IMPORT_TIMEOUT } from '../../initializers/constants'
+import { VideoRedundancyModel } from '../../models/redundancy/video-redundancy'
 import { sendCreateCacheFile, sendUpdateCacheFile } from '../activitypub/send'
-import { getVideoCacheFileActivityPubUrl } from '../activitypub/url'
+import { getLocalVideoCacheFileActivityPubUrl, getLocalVideoCacheStreamingPlaylistActivityPubUrl } from '../activitypub/url'
+import { getOrCreateAPVideo } from '../activitypub/videos'
+import { downloadPlaylistSegments } from '../hls'
 import { removeVideoRedundancy } from '../redundancy'
-import { getOrCreateVideoAndAccountAndChannel } from '../activitypub'
+import { generateHLSRedundancyUrl, generateWebTorrentRedundancyUrl } from '../video-urls'
+import { AbstractScheduler } from './abstract-scheduler'
+
+const lTags = loggerTagsFactory('redundancy')
+
+type CandidateToDuplicate = {
+  redundancy: VideosRedundancyStrategy
+  video: MVideoWithAllFiles
+  files: MVideoFile[]
+  streamingPlaylists: MStreamingPlaylistFiles[]
+}
+
+function isMVideoRedundancyFileVideo (
+  o: MVideoRedundancyFileVideo | MVideoRedundancyStreamingPlaylistVideo
+): o is MVideoRedundancyFileVideo {
+  return !!(o as MVideoRedundancyFileVideo).VideoFile
+}
 
 export class VideosRedundancyScheduler extends AbstractScheduler {
 
-  private static instance: AbstractScheduler
-  private executing = false
+  private static instance: VideosRedundancyScheduler
 
   protected schedulerIntervalMs = CONFIG.REDUNDANCY.VIDEOS.CHECK_INTERVAL
 
@@ -24,41 +51,58 @@ export class VideosRedundancyScheduler extends AbstractScheduler {
     super()
   }
 
-  async execute () {
-    if (this.executing) return
+  async createManualRedundancy (videoId: number) {
+    const videoToDuplicate = await VideoModel.loadWithFiles(videoId)
+
+    if (!videoToDuplicate) {
+      logger.warn('Video to manually duplicate %d does not exist anymore.', videoId, lTags())
+      return
+    }
 
-    this.executing = true
+    return this.createVideoRedundancies({
+      video: videoToDuplicate,
+      redundancy: null,
+      files: videoToDuplicate.VideoFiles,
+      streamingPlaylists: videoToDuplicate.VideoStreamingPlaylists
+    })
+  }
 
-    for (const obj of CONFIG.REDUNDANCY.VIDEOS.STRATEGIES) {
-      logger.info('Running redundancy scheduler for strategy %s.', obj.strategy)
+  protected async internalExecute () {
+    for (const redundancyConfig of CONFIG.REDUNDANCY.VIDEOS.STRATEGIES) {
+      logger.info('Running redundancy scheduler for strategy %s.', redundancyConfig.strategy, lTags())
 
       try {
-        const videoToDuplicate = await this.findVideoToDuplicate(obj)
+        const videoToDuplicate = await this.findVideoToDuplicate(redundancyConfig)
         if (!videoToDuplicate) continue
 
-        const videoFiles = videoToDuplicate.VideoFiles
-        videoFiles.forEach(f => f.Video = videoToDuplicate)
+        const candidateToDuplicate = {
+          video: videoToDuplicate,
+          redundancy: redundancyConfig,
+          files: videoToDuplicate.VideoFiles,
+          streamingPlaylists: videoToDuplicate.VideoStreamingPlaylists
+        }
 
-        await this.purgeCacheIfNeeded(obj, videoFiles)
+        await this.purgeCacheIfNeeded(candidateToDuplicate)
 
-        if (await this.isTooHeavy(obj, videoFiles)) {
-          logger.info('Video %s is too big for our cache, skipping.', videoToDuplicate.url)
+        if (await this.isTooHeavy(candidateToDuplicate)) {
+          logger.info('Video %s is too big for our cache, skipping.', videoToDuplicate.url, lTags(videoToDuplicate.uuid))
           continue
         }
 
-        logger.info('Will duplicate video %s in redundancy scheduler "%s".', videoToDuplicate.url, obj.strategy)
+        logger.info(
+          'Will duplicate video %s in redundancy scheduler "%s".',
+          videoToDuplicate.url, redundancyConfig.strategy, lTags(videoToDuplicate.uuid)
+        )
 
-        await this.createVideoRedundancy(obj, videoFiles)
+        await this.createVideoRedundancies(candidateToDuplicate)
       } catch (err) {
-        logger.error('Cannot run videos redundancy %s.', obj.strategy, { err })
+        logger.error('Cannot run videos redundancy %s.', redundancyConfig.strategy, { err, ...lTags() })
       }
     }
 
     await this.extendsLocalExpiration()
 
     await this.purgeRemoteExpired()
-
-    this.executing = false
   }
 
   static get Instance () {
@@ -70,14 +114,45 @@ export class VideosRedundancyScheduler extends AbstractScheduler {
 
     for (const redundancyModel of expired) {
       try {
-        const redundancy = CONFIG.REDUNDANCY.VIDEOS.STRATEGIES.find(s => s.strategy === redundancyModel.strategy)
-        await this.extendsExpirationOf(redundancyModel, redundancy.minLifetime)
+        const redundancyConfig = CONFIG.REDUNDANCY.VIDEOS.STRATEGIES.find(s => s.strategy === redundancyModel.strategy)
+        const candidate: CandidateToDuplicate = {
+          redundancy: redundancyConfig,
+          video: null,
+          files: [],
+          streamingPlaylists: []
+        }
+
+        // If the administrator disabled the redundancy or decreased the cache size, remove this redundancy instead of extending it
+        if (!redundancyConfig || await this.isTooHeavy(candidate)) {
+          logger.info(
+            'Destroying redundancy %s because the cache size %s is too heavy.',
+            redundancyModel.url, redundancyModel.strategy, lTags(candidate.video.uuid)
+          )
+
+          await removeVideoRedundancy(redundancyModel)
+        } else {
+          await this.extendsRedundancy(redundancyModel)
+        }
       } catch (err) {
-        logger.error('Cannot extend expiration of %s video from our redundancy system.', this.buildEntryLogId(redundancyModel))
+        logger.error(
+          'Cannot extend or remove expiration of %s video from our redundancy system.',
+          this.buildEntryLogId(redundancyModel), { err, ...lTags(redundancyModel.getVideoUUID()) }
+        )
       }
     }
   }
 
+  private async extendsRedundancy (redundancyModel: MVideoRedundancyVideo) {
+    const redundancy = CONFIG.REDUNDANCY.VIDEOS.STRATEGIES.find(s => s.strategy === redundancyModel.strategy)
+    // Redundancy strategy disabled, remove our redundancy instead of extending expiration
+    if (!redundancy) {
+      await removeVideoRedundancy(redundancyModel)
+      return
+    }
+
+    await this.extendsExpirationOf(redundancyModel, redundancy.minLifetime)
+  }
+
   private async purgeRemoteExpired () {
     const expired = await VideoRedundancyModel.listRemoteExpired()
 
@@ -85,12 +160,15 @@ export class VideosRedundancyScheduler extends AbstractScheduler {
       try {
         await removeVideoRedundancy(redundancyModel)
       } catch (err) {
-        logger.error('Cannot remove redundancy %s from our redundancy system.', this.buildEntryLogId(redundancyModel))
+        logger.error(
+          'Cannot remove redundancy %s from our redundancy system.',
+          this.buildEntryLogId(redundancyModel), lTags(redundancyModel.getVideoUUID())
+        )
       }
     }
   }
 
-  private findVideoToDuplicate (cache: VideosRedundancy) {
+  private findVideoToDuplicate (cache: VideosRedundancyStrategy) {
     if (cache.strategy === 'most-views') {
       return VideoRedundancyModel.findMostViewToDuplicate(REDUNDANCY.VIDEOS.RANDOMIZED_FACTOR)
     }
@@ -105,63 +183,118 @@ export class VideosRedundancyScheduler extends AbstractScheduler {
     }
   }
 
-  private async createVideoRedundancy (redundancy: VideosRedundancy, filesToDuplicate: VideoFileModel[]) {
-    const serverActor = await getServerActor()
+  private async createVideoRedundancies (data: CandidateToDuplicate) {
+    const video = await this.loadAndRefreshVideo(data.video.url)
 
-    for (const file of filesToDuplicate) {
-      // We need more attributes and check if the video still exists
-      const getVideoOptions = {
-        videoObject: file.Video.url,
-        syncParam: { likes: false, dislikes: false, shares: false, comments: false, thumbnail: false, refreshVideo: true },
-        fetchType: 'all' as 'all'
-      }
-      const { video } = await getOrCreateVideoAndAccountAndChannel(getVideoOptions)
+    if (!video) {
+      logger.info('Video %s we want to duplicate does not existing anymore, skipping.', data.video.url, lTags(data.video.uuid))
 
-      const existing = await VideoRedundancyModel.loadLocalByFileId(file.id)
-      if (existing) {
-        if (video) {
-          await this.extendsExpirationOf(existing, redundancy.minLifetime)
-        } else {
-          logger.info('Destroying existing redundancy %s, because the associated video does not exist anymore.', existing.url)
+      return
+    }
 
-          await existing.destroy()
-        }
+    for (const file of data.files) {
+      const existingRedundancy = await VideoRedundancyModel.loadLocalByFileId(file.id)
+      if (existingRedundancy) {
+        await this.extendsRedundancy(existingRedundancy)
 
         continue
       }
 
-      if (!video) {
-        logger.info('Video %s we want to duplicate does not existing anymore, skipping.', file.Video.url)
+      await this.createVideoFileRedundancy(data.redundancy, video, file)
+    }
+
+    for (const streamingPlaylist of data.streamingPlaylists) {
+      const existingRedundancy = await VideoRedundancyModel.loadLocalByStreamingPlaylistId(streamingPlaylist.id)
+      if (existingRedundancy) {
+        await this.extendsRedundancy(existingRedundancy)
 
         continue
       }
 
-      logger.info('Duplicating %s - %d in videos redundancy with "%s" strategy.', video.url, file.resolution, redundancy.strategy)
+      await this.createStreamingPlaylistRedundancy(data.redundancy, video, streamingPlaylist)
+    }
+  }
+
+  private async createVideoFileRedundancy (redundancy: VideosRedundancyStrategy | null, video: MVideoAccountLight, fileArg: MVideoFile) {
+    let strategy = 'manual'
+    let expiresOn: Date = null
+
+    if (redundancy) {
+      strategy = redundancy.strategy
+      expiresOn = this.buildNewExpiration(redundancy.minLifetime)
+    }
+
+    const file = fileArg as MVideoFileVideo
+    file.Video = video
+
+    const serverActor = await getServerActor()
+
+    logger.info('Duplicating %s - %d in videos redundancy with "%s" strategy.', video.url, file.resolution, strategy, lTags(video.uuid))
 
-      const { baseUrlHttp, baseUrlWs } = video.getBaseUrls()
-      const magnetUri = video.generateMagnetUri(file, baseUrlHttp, baseUrlWs)
+    const tmpPath = await downloadWebTorrentVideo({ uri: file.torrentUrl }, VIDEO_IMPORT_TIMEOUT)
 
-      const tmpPath = await downloadWebTorrentVideo({ magnetUri }, VIDEO_IMPORT_TIMEOUT)
+    const destPath = join(CONFIG.STORAGE.REDUNDANCY_DIR, file.filename)
+    await move(tmpPath, destPath, { overwrite: true })
 
-      const destPath = join(CONFIG.STORAGE.VIDEOS_DIR, video.getVideoFilename(file))
-      await rename(tmpPath, destPath)
+    const createdModel: MVideoRedundancyFileVideo = await VideoRedundancyModel.create({
+      expiresOn,
+      url: getLocalVideoCacheFileActivityPubUrl(file),
+      fileUrl: generateWebTorrentRedundancyUrl(file),
+      strategy,
+      videoFileId: file.id,
+      actorId: serverActor.id
+    })
 
-      const createdModel = await VideoRedundancyModel.create({
-        expiresOn: this.buildNewExpiration(redundancy.minLifetime),
-        url: getVideoCacheFileActivityPubUrl(file),
-        fileUrl: video.getVideoFileUrl(file, CONFIG.WEBSERVER.URL),
-        strategy: redundancy.strategy,
-        videoFileId: file.id,
-        actorId: serverActor.id
-      })
-      createdModel.VideoFile = file
+    createdModel.VideoFile = file
 
-      await sendCreateCacheFile(serverActor, createdModel)
+    await sendCreateCacheFile(serverActor, video, createdModel)
+
+    logger.info('Duplicated %s - %d -> %s.', video.url, file.resolution, createdModel.url, lTags(video.uuid))
+  }
+
+  private async createStreamingPlaylistRedundancy (
+    redundancy: VideosRedundancyStrategy,
+    video: MVideoAccountLight,
+    playlistArg: MStreamingPlaylistFiles
+  ) {
+    let strategy = 'manual'
+    let expiresOn: Date = null
+
+    if (redundancy) {
+      strategy = redundancy.strategy
+      expiresOn = this.buildNewExpiration(redundancy.minLifetime)
     }
+
+    const playlist = Object.assign(playlistArg, { Video: video })
+    const serverActor = await getServerActor()
+
+    logger.info('Duplicating %s streaming playlist in videos redundancy with "%s" strategy.', video.url, strategy, lTags(video.uuid))
+
+    const destDirectory = join(HLS_REDUNDANCY_DIRECTORY, video.uuid)
+    const masterPlaylistUrl = playlist.getMasterPlaylistUrl(video)
+
+    const maxSizeKB = this.getTotalFileSizes([], [ playlist ]) / 1000
+    const toleranceKB = maxSizeKB + ((5 * maxSizeKB) / 100) // 5% more tolerance
+    await downloadPlaylistSegments(masterPlaylistUrl, destDirectory, VIDEO_IMPORT_TIMEOUT, toleranceKB)
+
+    const createdModel: MVideoRedundancyStreamingPlaylistVideo = await VideoRedundancyModel.create({
+      expiresOn,
+      url: getLocalVideoCacheStreamingPlaylistActivityPubUrl(video, playlist),
+      fileUrl: generateHLSRedundancyUrl(video, playlistArg),
+      strategy,
+      videoStreamingPlaylistId: playlist.id,
+      actorId: serverActor.id
+    })
+
+    createdModel.VideoStreamingPlaylist = playlist
+
+    await sendCreateCacheFile(serverActor, video, createdModel)
+
+    logger.info('Duplicated playlist %s -> %s.', masterPlaylistUrl, createdModel.url, lTags(video.uuid))
   }
 
-  private async extendsExpirationOf (redundancy: VideoRedundancyModel, expiresAfterMs: number) {
-    logger.info('Extending expiration of %s.', redundancy.url)
+  private async extendsExpirationOf (redundancy: MVideoRedundancyVideo, expiresAfterMs: number) {
+    logger.info('Extending expiration of %s.', redundancy.url, lTags(redundancy.getVideoUUID()))
 
     const serverActor = await getServerActor()
 
@@ -171,34 +304,67 @@ export class VideosRedundancyScheduler extends AbstractScheduler {
     await sendUpdateCacheFile(serverActor, redundancy)
   }
 
-  private async purgeCacheIfNeeded (redundancy: VideosRedundancy, filesToDuplicate: VideoFileModel[]) {
-    while (this.isTooHeavy(redundancy, filesToDuplicate)) {
-      const toDelete = await VideoRedundancyModel.loadOldestLocalThatAlreadyExpired(redundancy.strategy, redundancy.minLifetime)
+  private async purgeCacheIfNeeded (candidateToDuplicate: CandidateToDuplicate) {
+    while (await this.isTooHeavy(candidateToDuplicate)) {
+      const redundancy = candidateToDuplicate.redundancy
+      const toDelete = await VideoRedundancyModel.loadOldestLocalExpired(redundancy.strategy, redundancy.minLifetime)
       if (!toDelete) return
 
-      await removeVideoRedundancy(toDelete)
+      const videoId = toDelete.VideoFile
+        ? toDelete.VideoFile.videoId
+        : toDelete.VideoStreamingPlaylist.videoId
+
+      const redundancies = await VideoRedundancyModel.listLocalByVideoId(videoId)
+
+      for (const redundancy of redundancies) {
+        await removeVideoRedundancy(redundancy)
+      }
     }
   }
 
-  private async isTooHeavy (redundancy: VideosRedundancy, filesToDuplicate: VideoFileModel[]) {
-    const maxSize = redundancy.size - this.getTotalFileSizes(filesToDuplicate)
+  private async isTooHeavy (candidateToDuplicate: CandidateToDuplicate) {
+    const maxSize = candidateToDuplicate.redundancy.size
+
+    const { totalUsed: alreadyUsed } = await VideoRedundancyModel.getStats(candidateToDuplicate.redundancy.strategy)
 
-    const totalDuplicated = await VideoRedundancyModel.getTotalDuplicated(redundancy.strategy)
+    const videoSize = this.getTotalFileSizes(candidateToDuplicate.files, candidateToDuplicate.streamingPlaylists)
+    const willUse = alreadyUsed + videoSize
 
-    return totalDuplicated > maxSize
+    logger.debug('Checking candidate size.', { maxSize, alreadyUsed, videoSize, willUse, ...lTags(candidateToDuplicate.video.uuid) })
+
+    return willUse > maxSize
   }
 
   private buildNewExpiration (expiresAfterMs: number) {
     return new Date(Date.now() + expiresAfterMs)
   }
 
-  private buildEntryLogId (object: VideoRedundancyModel) {
-    return `${object.VideoFile.Video.url}-${object.VideoFile.resolution}`
+  private buildEntryLogId (object: MVideoRedundancyFileVideo | MVideoRedundancyStreamingPlaylistVideo) {
+    if (isMVideoRedundancyFileVideo(object)) return `${object.VideoFile.Video.url}-${object.VideoFile.resolution}`
+
+    return `${object.VideoStreamingPlaylist.getMasterPlaylistUrl(object.VideoStreamingPlaylist.Video)}`
+  }
+
+  private getTotalFileSizes (files: MVideoFile[], playlists: MStreamingPlaylistFiles[]): number {
+    const fileReducer = (previous: number, current: MVideoFile) => previous + current.size
+
+    let allFiles = files
+    for (const p of playlists) {
+      allFiles = allFiles.concat(p.VideoFiles)
+    }
+
+    return allFiles.reduce(fileReducer, 0)
   }
 
-  private getTotalFileSizes (files: VideoFileModel[]) {
-    const fileReducer = (previous: number, current: VideoFileModel) => previous + current.size
+  private async loadAndRefreshVideo (videoUrl: string) {
+    // We need more attributes and check if the video still exists
+    const getVideoOptions = {
+      videoObject: videoUrl,
+      syncParam: { likes: false, dislikes: false, shares: false, comments: false, thumbnail: false, refreshVideo: true },
+      fetchType: 'all' as 'all'
+    }
+    const { video } = await getOrCreateAPVideo(getVideoOptions)
 
-    return files.reduce(fileReducer, 0)
+    return video
   }
 }