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

376 lines
13 KiB
TypeScript
Raw Normal View History

import { move } from 'fs-extra/esm'
2020-11-20 11:21:08 +01:00
import { join } from 'path'
import { getServerActor } from '@server/models/application/application.js'
import { VideoModel } from '@server/models/video/video.js'
2019-08-15 11:53:26 +02:00
import {
2020-11-20 11:21:08 +01:00
MStreamingPlaylistFiles,
2019-08-15 11:53:26 +02:00
MVideoAccountLight,
MVideoFile,
MVideoFileVideo,
MVideoRedundancyFileVideo,
MVideoRedundancyStreamingPlaylistVideo,
MVideoRedundancyVideo,
MVideoWithAllFiles
} from '@server/types/models/index.js'
import { VideosRedundancyStrategy } from '@peertube/peertube-models'
import { logger, loggerTagsFactory } from '../../helpers/logger.js'
import { downloadWebTorrentVideo } from '../../helpers/webtorrent.js'
import { CONFIG } from '../../initializers/config.js'
import { DIRECTORIES, REDUNDANCY, VIDEO_IMPORT_TIMEOUT } from '../../initializers/constants.js'
import { VideoRedundancyModel } from '../../models/redundancy/video-redundancy.js'
import { sendCreateCacheFile, sendUpdateCacheFile } from '../activitypub/send/index.js'
import { getLocalVideoCacheFileActivityPubUrl, getLocalVideoCacheStreamingPlaylistActivityPubUrl } from '../activitypub/url.js'
import { getOrCreateAPVideo } from '../activitypub/videos/index.js'
import { downloadPlaylistSegments } from '../hls.js'
import { removeVideoRedundancy } from '../redundancy.js'
import { generateHLSRedundancyUrl, generateWebVideoRedundancyUrl } from '../video-urls.js'
import { AbstractScheduler } from './abstract-scheduler.js'
2019-01-29 08:37:25 +01:00
2021-08-26 11:01:59 +02:00
const lTags = loggerTagsFactory('redundancy')
2019-01-29 08:37:25 +01:00
type CandidateToDuplicate = {
2020-01-31 16:56:52 +01:00
redundancy: VideosRedundancyStrategy
video: MVideoWithAllFiles
files: MVideoFile[]
2019-11-21 12:16:27 +01:00
streamingPlaylists: MStreamingPlaylistFiles[]
2019-08-15 11:53:26 +02:00
}
2019-08-20 13:52:49 +02:00
function isMVideoRedundancyFileVideo (
o: MVideoRedundancyFileVideo | MVideoRedundancyStreamingPlaylistVideo
): o is MVideoRedundancyFileVideo {
2019-08-15 11:53:26 +02:00
return !!(o as MVideoRedundancyFileVideo).VideoFile
2019-01-29 08:37:25 +01:00
}
2018-09-11 16:27:07 +02:00
export class VideosRedundancyScheduler extends AbstractScheduler {
2020-01-10 10:11:28 +01:00
private static instance: VideosRedundancyScheduler
2018-09-11 16:27:07 +02:00
protected schedulerIntervalMs = CONFIG.REDUNDANCY.VIDEOS.CHECK_INTERVAL
2018-09-11 16:27:07 +02:00
private constructor () {
super()
}
2020-01-10 10:11:28 +01:00
async createManualRedundancy (videoId: number) {
const videoToDuplicate = await VideoModel.loadWithFiles(videoId)
if (!videoToDuplicate) {
2021-08-26 11:01:59 +02:00
logger.warn('Video to manually duplicate %d does not exist anymore.', videoId, lTags())
2020-01-10 10:11:28 +01:00
return
}
return this.createVideoRedundancies({
video: videoToDuplicate,
redundancy: null,
files: videoToDuplicate.VideoFiles,
streamingPlaylists: videoToDuplicate.VideoStreamingPlaylists
})
}
protected async internalExecute () {
2019-01-29 08:37:25 +01:00
for (const redundancyConfig of CONFIG.REDUNDANCY.VIDEOS.STRATEGIES) {
2021-08-26 11:01:59 +02:00
logger.info('Running redundancy scheduler for strategy %s.', redundancyConfig.strategy, lTags())
2018-09-11 16:27:07 +02:00
try {
2019-01-29 08:37:25 +01:00
const videoToDuplicate = await this.findVideoToDuplicate(redundancyConfig)
2018-09-11 16:27:07 +02:00
if (!videoToDuplicate) continue
2019-01-29 08:37:25 +01:00
const candidateToDuplicate = {
video: videoToDuplicate,
redundancy: redundancyConfig,
files: videoToDuplicate.VideoFiles,
streamingPlaylists: videoToDuplicate.VideoStreamingPlaylists
}
2018-09-11 16:27:07 +02:00
2019-01-29 08:37:25 +01:00
await this.purgeCacheIfNeeded(candidateToDuplicate)
2019-01-29 08:37:25 +01:00
if (await this.isTooHeavy(candidateToDuplicate)) {
2021-08-26 11:01:59 +02:00
logger.info('Video %s is too big for our cache, skipping.', videoToDuplicate.url, lTags(videoToDuplicate.uuid))
2018-09-11 16:27:07 +02:00
continue
}
2021-08-26 11:01:59 +02:00
logger.info(
'Will duplicate video %s in redundancy scheduler "%s".',
videoToDuplicate.url, redundancyConfig.strategy, lTags(videoToDuplicate.uuid)
)
2018-09-11 16:27:07 +02:00
2019-01-29 08:37:25 +01:00
await this.createVideoRedundancies(candidateToDuplicate)
2018-09-11 16:27:07 +02:00
} catch (err) {
2021-08-26 11:01:59 +02:00
logger.error('Cannot run videos redundancy %s.', redundancyConfig.strategy, { err, ...lTags() })
2018-09-11 16:27:07 +02:00
}
}
await this.extendsLocalExpiration()
await this.purgeRemoteExpired()
}
static get Instance () {
return this.instance || (this.instance = new this())
}
private async extendsLocalExpiration () {
const expired = await VideoRedundancyModel.listLocalExpired()
for (const redundancyModel of expired) {
try {
2019-01-29 08:37:25 +01:00
const redundancyConfig = CONFIG.REDUNDANCY.VIDEOS.STRATEGIES.find(s => s.strategy === redundancyModel.strategy)
2022-10-31 08:57:52 +01:00
// If the admin disabled the redundancy, remove this redundancy instead of extending it
if (!redundancyConfig) {
logger.info(
'Destroying redundancy %s because the redundancy %s does not exist anymore.',
redundancyModel.url, redundancyModel.strategy
)
await removeVideoRedundancy(redundancyModel)
continue
}
const { totalUsed } = await VideoRedundancyModel.getStats(redundancyConfig.strategy)
2019-01-29 08:37:25 +01:00
2022-10-31 08:57:52 +01:00
// If the admin decreased the cache size, remove this redundancy instead of extending it
if (totalUsed > redundancyConfig.size) {
logger.info('Destroying redundancy %s because the cache size %s is too heavy.', redundancyModel.url, redundancyModel.strategy)
2021-08-26 11:01:59 +02:00
2019-01-29 08:37:25 +01:00
await removeVideoRedundancy(redundancyModel)
2022-10-31 08:57:52 +01:00
continue
2019-01-29 08:37:25 +01:00
}
2022-10-31 08:57:52 +01:00
await this.extendsRedundancy(redundancyModel)
} catch (err) {
2019-01-29 08:37:25 +01:00
logger.error(
2021-08-26 11:01:59 +02:00
'Cannot extend or remove expiration of %s video from our redundancy system.',
this.buildEntryLogId(redundancyModel), { err, ...lTags(redundancyModel.getVideoUUID()) }
2019-01-29 08:37:25 +01:00
)
}
}
}
2018-09-11 16:27:07 +02:00
2019-08-15 11:53:26 +02:00
private async extendsRedundancy (redundancyModel: MVideoRedundancyVideo) {
const redundancy = CONFIG.REDUNDANCY.VIDEOS.STRATEGIES.find(s => s.strategy === redundancyModel.strategy)
2019-01-29 08:37:25 +01:00
// Redundancy strategy disabled, remove our redundancy instead of extending expiration
2019-08-12 08:46:46 +02:00
if (!redundancy) {
await removeVideoRedundancy(redundancyModel)
return
}
2019-01-29 08:37:25 +01:00
await this.extendsExpirationOf(redundancyModel, redundancy.minLifetime)
}
private async purgeRemoteExpired () {
const expired = await VideoRedundancyModel.listRemoteExpired()
2018-09-11 16:27:07 +02:00
for (const redundancyModel of expired) {
2018-09-11 16:27:07 +02:00
try {
await removeVideoRedundancy(redundancyModel)
2018-09-11 16:27:07 +02:00
} catch (err) {
2021-08-26 11:01:59 +02:00
logger.error(
'Cannot remove redundancy %s from our redundancy system.',
this.buildEntryLogId(redundancyModel), lTags(redundancyModel.getVideoUUID())
)
2018-09-11 16:27:07 +02:00
}
}
}
2020-01-10 10:11:28 +01:00
private findVideoToDuplicate (cache: VideosRedundancyStrategy) {
2018-09-14 11:05:38 +02:00
if (cache.strategy === 'most-views') {
return VideoRedundancyModel.findMostViewToDuplicate(REDUNDANCY.VIDEOS.RANDOMIZED_FACTOR)
}
if (cache.strategy === 'trending') {
return VideoRedundancyModel.findTrendingToDuplicate(REDUNDANCY.VIDEOS.RANDOMIZED_FACTOR)
}
2018-09-14 09:57:21 +02:00
2018-09-14 11:05:38 +02:00
if (cache.strategy === 'recently-added') {
2018-09-14 11:52:23 +02:00
const minViews = cache.minViews
2018-09-14 11:05:38 +02:00
return VideoRedundancyModel.findRecentlyAddedToDuplicate(REDUNDANCY.VIDEOS.RANDOMIZED_FACTOR, minViews)
}
2018-09-11 16:27:07 +02:00
}
2019-01-29 08:37:25 +01:00
private async createVideoRedundancies (data: CandidateToDuplicate) {
const video = await this.loadAndRefreshVideo(data.video.url)
if (!video) {
2021-08-26 11:01:59 +02:00
logger.info('Video %s we want to duplicate does not existing anymore, skipping.', data.video.url, lTags(data.video.uuid))
2018-09-11 16:27:07 +02:00
2019-01-29 08:37:25 +01:00
return
}
2019-01-29 08:37:25 +01:00
for (const file of data.files) {
const existingRedundancy = await VideoRedundancyModel.loadLocalByFileId(file.id)
if (existingRedundancy) {
2019-01-29 08:37:25 +01:00
await this.extendsRedundancy(existingRedundancy)
2018-09-11 16:27:07 +02:00
continue
}
2019-01-29 08:37:25 +01:00
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
}
2018-09-11 16:27:07 +02:00
2019-01-29 08:37:25 +01:00
await this.createStreamingPlaylistRedundancy(data.redundancy, video, streamingPlaylist)
}
}
2018-09-11 16:27:07 +02:00
2020-01-10 10:11:28 +01:00
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)
}
2019-08-15 11:53:26 +02:00
const file = fileArg as MVideoFileVideo
2019-01-29 08:37:25 +01:00
file.Video = video
2018-09-11 16:27:07 +02:00
2019-01-29 08:37:25 +01:00
const serverActor = await getServerActor()
2018-09-11 16:27:07 +02:00
2021-08-26 11:01:59 +02:00
logger.info('Duplicating %s - %d in videos redundancy with "%s" strategy.', video.url, file.resolution, strategy, lTags(video.uuid))
2018-09-11 16:27:07 +02:00
const tmpPath = await downloadWebTorrentVideo({ uri: file.torrentUrl }, VIDEO_IMPORT_TIMEOUT)
2018-10-02 09:04:19 +02:00
const destPath = join(CONFIG.STORAGE.REDUNDANCY_DIR, file.filename)
2019-08-22 11:03:50 +02:00
await move(tmpPath, destPath, { overwrite: true })
2019-01-29 08:37:25 +01:00
2019-08-15 11:53:26 +02:00
const createdModel: MVideoRedundancyFileVideo = await VideoRedundancyModel.create({
2020-01-10 10:11:28 +01:00
expiresOn,
2020-11-20 11:21:08 +01:00
url: getLocalVideoCacheFileActivityPubUrl(file),
fileUrl: generateWebVideoRedundancyUrl(file),
2020-01-10 10:11:28 +01:00
strategy,
2019-01-29 08:37:25 +01:00
videoFileId: file.id,
actorId: serverActor.id
})
createdModel.VideoFile = file
await sendCreateCacheFile(serverActor, video, createdModel)
2021-08-26 11:01:59 +02:00
logger.info('Duplicated %s - %d -> %s.', video.url, file.resolution, createdModel.url, lTags(video.uuid))
2019-01-29 08:37:25 +01:00
}
2019-08-15 11:53:26 +02:00
private async createStreamingPlaylistRedundancy (
2020-01-10 10:11:28 +01:00
redundancy: VideosRedundancyStrategy,
2019-08-15 11:53:26 +02:00
video: MVideoAccountLight,
playlistArg: MStreamingPlaylistFiles
2019-08-15 11:53:26 +02:00
) {
2020-01-10 10:11:28 +01:00
let strategy = 'manual'
let expiresOn: Date = null
if (redundancy) {
strategy = redundancy.strategy
expiresOn = this.buildNewExpiration(redundancy.minLifetime)
}
const playlist = Object.assign(playlistArg, { Video: video })
2019-01-29 08:37:25 +01:00
const serverActor = await getServerActor()
2021-08-26 11:01:59 +02:00
logger.info('Duplicating %s streaming playlist in videos redundancy with "%s" strategy.', video.url, strategy, lTags(video.uuid))
2019-01-29 08:37:25 +01:00
const destDirectory = join(DIRECTORIES.HLS_REDUNDANCY, video.uuid)
2021-07-23 11:20:00 +02:00
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)
2019-01-29 08:37:25 +01:00
2019-08-15 11:53:26 +02:00
const createdModel: MVideoRedundancyStreamingPlaylistVideo = await VideoRedundancyModel.create({
2020-01-10 10:11:28 +01:00
expiresOn,
2020-11-20 11:21:08 +01:00
url: getLocalVideoCacheStreamingPlaylistActivityPubUrl(video, playlist),
fileUrl: generateHLSRedundancyUrl(video, playlistArg),
2020-01-10 10:11:28 +01:00
strategy,
2019-01-29 08:37:25 +01:00
videoStreamingPlaylistId: playlist.id,
actorId: serverActor.id
})
createdModel.VideoStreamingPlaylist = playlist
await sendCreateCacheFile(serverActor, video, createdModel)
2021-08-26 11:01:59 +02:00
logger.info('Duplicated playlist %s -> %s.', masterPlaylistUrl, createdModel.url, lTags(video.uuid))
2018-09-11 16:27:07 +02:00
}
2019-08-15 11:53:26 +02:00
private async extendsExpirationOf (redundancy: MVideoRedundancyVideo, expiresAfterMs: number) {
2021-08-26 11:01:59 +02:00
logger.info('Extending expiration of %s.', redundancy.url, lTags(redundancy.getVideoUUID()))
const serverActor = await getServerActor()
redundancy.expiresOn = this.buildNewExpiration(expiresAfterMs)
await redundancy.save()
await sendUpdateCacheFile(serverActor, redundancy)
}
2019-01-29 08:37:25 +01:00
private async purgeCacheIfNeeded (candidateToDuplicate: CandidateToDuplicate) {
2019-09-04 14:40:29 +02:00
while (await this.isTooHeavy(candidateToDuplicate)) {
2019-01-29 08:37:25 +01:00
const redundancy = candidateToDuplicate.redundancy
2019-08-15 11:53:26 +02:00
const toDelete = await VideoRedundancyModel.loadOldestLocalExpired(redundancy.strategy, redundancy.minLifetime)
if (!toDelete) return
2021-02-02 08:48:48 +01:00
const videoId = toDelete.VideoFile
? toDelete.VideoFile.videoId
: toDelete.VideoStreamingPlaylist.videoId
const redundancies = await VideoRedundancyModel.listLocalByVideoId(videoId)
for (const redundancy of redundancies) {
await removeVideoRedundancy(redundancy)
}
}
}
2019-01-29 08:37:25 +01:00
private async isTooHeavy (candidateToDuplicate: CandidateToDuplicate) {
const maxSize = candidateToDuplicate.redundancy.size
2018-09-11 16:27:07 +02:00
2021-08-26 15:19:11 +02:00
const { totalUsed: alreadyUsed } = await VideoRedundancyModel.getStats(candidateToDuplicate.redundancy.strategy)
2021-08-26 11:01:59 +02:00
const videoSize = this.getTotalFileSizes(candidateToDuplicate.files, candidateToDuplicate.streamingPlaylists)
2021-08-26 15:19:11 +02:00
const willUse = alreadyUsed + videoSize
2021-08-26 11:01:59 +02:00
2021-08-26 15:19:11 +02:00
logger.debug('Checking candidate size.', { maxSize, alreadyUsed, videoSize, willUse, ...lTags(candidateToDuplicate.video.uuid) })
2018-09-11 16:27:07 +02:00
2021-08-26 15:19:11 +02:00
return willUse > maxSize
2018-09-11 16:27:07 +02:00
}
private buildNewExpiration (expiresAfterMs: number) {
return new Date(Date.now() + expiresAfterMs)
2018-09-11 16:27:07 +02:00
}
2019-08-15 11:53:26 +02:00
private buildEntryLogId (object: MVideoRedundancyFileVideo | MVideoRedundancyStreamingPlaylistVideo) {
if (isMVideoRedundancyFileVideo(object)) return `${object.VideoFile.Video.url}-${object.VideoFile.resolution}`
2019-01-29 08:37:25 +01:00
2021-07-23 11:20:00 +02:00
return `${object.VideoStreamingPlaylist.getMasterPlaylistUrl(object.VideoStreamingPlaylist.Video)}`
2018-09-11 16:27:07 +02:00
}
private getTotalFileSizes (files: MVideoFile[], playlists: MStreamingPlaylistFiles[]): number {
2019-08-15 11:53:26 +02:00
const fileReducer = (previous: number, current: MVideoFile) => previous + current.size
2018-09-11 16:27:07 +02:00
2019-11-21 12:16:27 +01:00
let allFiles = files
for (const p of playlists) {
allFiles = allFiles.concat(p.VideoFiles)
}
2019-06-20 10:33:01 +02:00
2019-11-21 12:16:27 +01:00
return allFiles.reduce(fileReducer, 0)
2018-09-11 16:27:07 +02:00
}
private async loadAndRefreshVideo (videoUrl: string) {
// We need more attributes and check if the video still exists
const getVideoOptions = {
videoObject: videoUrl,
2023-07-25 14:26:12 +02:00
syncParam: { rates: false, shares: false, comments: false, refreshVideo: true },
fetchType: 'all' as 'all'
}
2021-06-02 15:47:05 +02:00
const { video } = await getOrCreateAPVideo(getVideoOptions)
return video
}
2018-09-11 16:27:07 +02:00
}