server/lib/schedulers/videos-redundancy-scheduler.ts

   1 import { AbstractScheduler } from './abstract-scheduler'
   2 import { HLS_REDUNDANCY_DIRECTORY, REDUNDANCY, VIDEO_IMPORT_TIMEOUT, WEBSERVER } from '../../initializers/constants'
   3 import { logger } from '../../helpers/logger'
   4 import { VideosRedundancy } from '../../../shared/models/redundancy'
   5 import { VideoRedundancyModel } from '../../models/redundancy/video-redundancy'
   6 import { VideoFileModel } from '../../models/video/video-file'
   7 import { downloadWebTorrentVideo } from '../../helpers/webtorrent'
   8 import { join } from 'path'
   9 import { move } from 'fs-extra'
  10 import { getServerActor } from '../../helpers/utils'
  11 import { sendCreateCacheFile, sendUpdateCacheFile } from '../activitypub/send'
  12 import { getVideoCacheFileActivityPubUrl, getVideoCacheStreamingPlaylistActivityPubUrl } from '../activitypub/url'
  13 import { removeVideoRedundancy } from '../redundancy'
  14 import { getOrCreateVideoAndAccountAndChannel } from '../activitypub'
  15 import { VideoStreamingPlaylistModel } from '../../models/video/video-streaming-playlist'
  16 import { VideoModel } from '../../models/video/video'
  17 import { downloadPlaylistSegments } from '../hls'
  18 import { CONFIG } from '../../initializers/config'
  19
  20 type CandidateToDuplicate = {
  21   redundancy: VideosRedundancy,
  22   video: VideoModel,
  23   files: VideoFileModel[],
  24   streamingPlaylists: VideoStreamingPlaylistModel[]
  25 }
  26
  27 export class VideosRedundancyScheduler extends AbstractScheduler {
  28
  29   private static instance: AbstractScheduler
  30
  31   protected schedulerIntervalMs = CONFIG.REDUNDANCY.VIDEOS.CHECK_INTERVAL
  32
  33   private constructor () {
  34     super()
  35   }
  36
  37   protected async internalExecute () {
  38     for (const redundancyConfig of CONFIG.REDUNDANCY.VIDEOS.STRATEGIES) {
  39       logger.info('Running redundancy scheduler for strategy %s.', redundancyConfig.strategy)
  40
  41       try {
  42         const videoToDuplicate = await this.findVideoToDuplicate(redundancyConfig)
  43         if (!videoToDuplicate) continue
  44
  45         const candidateToDuplicate = {
  46           video: videoToDuplicate,
  47           redundancy: redundancyConfig,
  48           files: videoToDuplicate.VideoFiles,
  49           streamingPlaylists: videoToDuplicate.VideoStreamingPlaylists
  50         }
  51
  52         await this.purgeCacheIfNeeded(candidateToDuplicate)
  53
  54         if (await this.isTooHeavy(candidateToDuplicate)) {
  55           logger.info('Video %s is too big for our cache, skipping.', videoToDuplicate.url)
  56           continue
  57         }
  58
  59         logger.info('Will duplicate video %s in redundancy scheduler "%s".', videoToDuplicate.url, redundancyConfig.strategy)
  60
  61         await this.createVideoRedundancies(candidateToDuplicate)
  62       } catch (err) {
  63         logger.error('Cannot run videos redundancy %s.', redundancyConfig.strategy, { err })
  64       }
  65     }
  66
  67     await this.extendsLocalExpiration()
  68
  69     await this.purgeRemoteExpired()
  70   }
  71
  72   static get Instance () {
  73     return this.instance || (this.instance = new this())
  74   }
  75
  76   private async extendsLocalExpiration () {
  77     const expired = await VideoRedundancyModel.listLocalExpired()
  78
  79     for (const redundancyModel of expired) {
  80       try {
  81         const redundancyConfig = CONFIG.REDUNDANCY.VIDEOS.STRATEGIES.find(s => s.strategy === redundancyModel.strategy)
  82         const candidate = {
  83           redundancy: redundancyConfig,
  84           video: null,
  85           files: [],
  86           streamingPlaylists: []
  87         }
  88
  89         // If the administrator disabled the redundancy or decreased the cache size, remove this redundancy instead of extending it
  90         if (!redundancyConfig || await this.isTooHeavy(candidate)) {
  91           logger.info('Destroying redundancy %s because the cache size %s is too heavy.', redundancyModel.url, redundancyModel.strategy)
  92           await removeVideoRedundancy(redundancyModel)
  93         } else {
  94           await this.extendsRedundancy(redundancyModel)
  95         }
  96       } catch (err) {
  97         logger.error(
  98           'Cannot extend or remove expiration of %s video from our redundancy system.', this.buildEntryLogId(redundancyModel),
  99           { err }
 100         )
 101       }
 102     }
 103   }
 104
 105   private async extendsRedundancy (redundancyModel: VideoRedundancyModel) {
 106     const redundancy = CONFIG.REDUNDANCY.VIDEOS.STRATEGIES.find(s => s.strategy === redundancyModel.strategy)
 107     // Redundancy strategy disabled, remove our redundancy instead of extending expiration
 108     if (!redundancy) {
 109       await removeVideoRedundancy(redundancyModel)
 110       return
 111     }
 112
 113     await this.extendsExpirationOf(redundancyModel, redundancy.minLifetime)
 114   }
 115
 116   private async purgeRemoteExpired () {
 117     const expired = await VideoRedundancyModel.listRemoteExpired()
 118
 119     for (const redundancyModel of expired) {
 120       try {
 121         await removeVideoRedundancy(redundancyModel)
 122       } catch (err) {
 123         logger.error('Cannot remove redundancy %s from our redundancy system.', this.buildEntryLogId(redundancyModel))
 124       }
 125     }
 126   }
 127
 128   private findVideoToDuplicate (cache: VideosRedundancy) {
 129     if (cache.strategy === 'most-views') {
 130       return VideoRedundancyModel.findMostViewToDuplicate(REDUNDANCY.VIDEOS.RANDOMIZED_FACTOR)
 131     }
 132
 133     if (cache.strategy === 'trending') {
 134       return VideoRedundancyModel.findTrendingToDuplicate(REDUNDANCY.VIDEOS.RANDOMIZED_FACTOR)
 135     }
 136
 137     if (cache.strategy === 'recently-added') {
 138       const minViews = cache.minViews
 139       return VideoRedundancyModel.findRecentlyAddedToDuplicate(REDUNDANCY.VIDEOS.RANDOMIZED_FACTOR, minViews)
 140     }
 141   }
 142
 143   private async createVideoRedundancies (data: CandidateToDuplicate) {
 144     const video = await this.loadAndRefreshVideo(data.video.url)
 145
 146     if (!video) {
 147       logger.info('Video %s we want to duplicate does not existing anymore, skipping.', data.video.url)
 148
 149       return
 150     }
 151
 152     for (const file of data.files) {
 153       const existingRedundancy = await VideoRedundancyModel.loadLocalByFileId(file.id)
 154       if (existingRedundancy) {
 155         await this.extendsRedundancy(existingRedundancy)
 156
 157         continue
 158       }
 159
 160       await this.createVideoFileRedundancy(data.redundancy, video, file)
 161     }
 162
 163     for (const streamingPlaylist of data.streamingPlaylists) {
 164       const existingRedundancy = await VideoRedundancyModel.loadLocalByStreamingPlaylistId(streamingPlaylist.id)
 165       if (existingRedundancy) {
 166         await this.extendsRedundancy(existingRedundancy)
 167
 168         continue
 169       }
 170
 171       await this.createStreamingPlaylistRedundancy(data.redundancy, video, streamingPlaylist)
 172     }
 173   }
 174
 175   private async createVideoFileRedundancy (redundancy: VideosRedundancy, video: VideoModel, file: VideoFileModel) {
 176     file.Video = video
 177
 178     const serverActor = await getServerActor()
 179
 180     logger.info('Duplicating %s - %d in videos redundancy with "%s" strategy.', video.url, file.resolution, redundancy.strategy)
 181
 182     const { baseUrlHttp, baseUrlWs } = video.getBaseUrls()
 183     const magnetUri = video.generateMagnetUri(file, baseUrlHttp, baseUrlWs)
 184
 185     const tmpPath = await downloadWebTorrentVideo({ magnetUri }, VIDEO_IMPORT_TIMEOUT)
 186
 187     const destPath = join(CONFIG.STORAGE.REDUNDANCY_DIR, video.getVideoFilename(file))
 188     await move(tmpPath, destPath, { overwrite: true })
 189
 190     const createdModel = await VideoRedundancyModel.create({
 191       expiresOn: this.buildNewExpiration(redundancy.minLifetime),
 192       url: getVideoCacheFileActivityPubUrl(file),
 193       fileUrl: video.getVideoRedundancyUrl(file, WEBSERVER.URL),
 194       strategy: redundancy.strategy,
 195       videoFileId: file.id,
 196       actorId: serverActor.id
 197     })
 198
 199     createdModel.VideoFile = file
 200
 201     await sendCreateCacheFile(serverActor, video, createdModel)
 202
 203     logger.info('Duplicated %s - %d -> %s.', video.url, file.resolution, createdModel.url)
 204   }
 205
 206   private async createStreamingPlaylistRedundancy (redundancy: VideosRedundancy, video: VideoModel, playlist: VideoStreamingPlaylistModel) {
 207     playlist.Video = video
 208
 209     const serverActor = await getServerActor()
 210
 211     logger.info('Duplicating %s streaming playlist in videos redundancy with "%s" strategy.', video.url, redundancy.strategy)
 212
 213     const destDirectory = join(HLS_REDUNDANCY_DIRECTORY, video.uuid)
 214     await downloadPlaylistSegments(playlist.playlistUrl, destDirectory, VIDEO_IMPORT_TIMEOUT)
 215
 216     const createdModel = await VideoRedundancyModel.create({
 217       expiresOn: this.buildNewExpiration(redundancy.minLifetime),
 218       url: getVideoCacheStreamingPlaylistActivityPubUrl(video, playlist),
 219       fileUrl: playlist.getVideoRedundancyUrl(WEBSERVER.URL),
 220       strategy: redundancy.strategy,
 221       videoStreamingPlaylistId: playlist.id,
 222       actorId: serverActor.id
 223     })
 224
 225     createdModel.VideoStreamingPlaylist = playlist
 226
 227     await sendCreateCacheFile(serverActor, video, createdModel)
 228
 229     logger.info('Duplicated playlist %s -> %s.', playlist.playlistUrl, createdModel.url)
 230   }
 231
 232   private async extendsExpirationOf (redundancy: VideoRedundancyModel, expiresAfterMs: number) {
 233     logger.info('Extending expiration of %s.', redundancy.url)
 234
 235     const serverActor = await getServerActor()
 236
 237     redundancy.expiresOn = this.buildNewExpiration(expiresAfterMs)
 238     await redundancy.save()
 239
 240     await sendUpdateCacheFile(serverActor, redundancy)
 241   }
 242
 243   private async purgeCacheIfNeeded (candidateToDuplicate: CandidateToDuplicate) {
 244     while (await this.isTooHeavy(candidateToDuplicate)) {
 245       const redundancy = candidateToDuplicate.redundancy
 246       const toDelete = await VideoRedundancyModel.loadOldestLocalThatAlreadyExpired(redundancy.strategy, redundancy.minLifetime)
 247       if (!toDelete) return
 248
 249       await removeVideoRedundancy(toDelete)
 250     }
 251   }
 252
 253   private async isTooHeavy (candidateToDuplicate: CandidateToDuplicate) {
 254     const maxSize = candidateToDuplicate.redundancy.size
 255
 256     const totalDuplicated = await VideoRedundancyModel.getTotalDuplicated(candidateToDuplicate.redundancy.strategy)
 257     const totalWillDuplicate = totalDuplicated + this.getTotalFileSizes(candidateToDuplicate.files, candidateToDuplicate.streamingPlaylists)
 258
 259     return totalWillDuplicate > maxSize
 260   }
 261
 262   private buildNewExpiration (expiresAfterMs: number) {
 263     return new Date(Date.now() + expiresAfterMs)
 264   }
 265
 266   private buildEntryLogId (object: VideoRedundancyModel) {
 267     if (object.VideoFile) return `${object.VideoFile.Video.url}-${object.VideoFile.resolution}`
 268
 269     return `${object.VideoStreamingPlaylist.playlistUrl}`
 270   }
 271
 272   private getTotalFileSizes (files: VideoFileModel[], playlists: VideoStreamingPlaylistModel[]) {
 273     const fileReducer = (previous: number, current: VideoFileModel) => previous + current.size
 274
 275     const totalSize = files.reduce(fileReducer, 0)
 276     if (playlists.length === 0) return totalSize
 277
 278     return totalSize * playlists.length
 279   }
 280
 281   private async loadAndRefreshVideo (videoUrl: string) {
 282     // We need more attributes and check if the video still exists
 283     const getVideoOptions = {
 284       videoObject: videoUrl,
 285       syncParam: { likes: false, dislikes: false, shares: false, comments: false, thumbnail: false, refreshVideo: true },
 286       fetchType: 'all' as 'all'
 287     }
 288     const { video } = await getOrCreateVideoAndAccountAndChannel(getVideoOptions)
 289
 290     return video
 291   }
 292 }