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