aboutsummaryrefslogtreecommitdiffhomepage
path: root/scripts/prune-storage.ts
diff options
context:
space:
mode:
authorChocobozzz <me@florianbigard.com>2023-07-31 14:34:36 +0200
committerChocobozzz <me@florianbigard.com>2023-08-11 15:02:33 +0200
commit3a4992633ee62d5edfbb484d9c6bcb3cf158489d (patch)
treee4510b39bdac9c318fdb4b47018d08f15368b8f0 /scripts/prune-storage.ts
parent04d1da5621d25d59bd5fa1543b725c497bf5d9a8 (diff)
downloadPeerTube-3a4992633ee62d5edfbb484d9c6bcb3cf158489d.tar.gz
PeerTube-3a4992633ee62d5edfbb484d9c6bcb3cf158489d.tar.zst
PeerTube-3a4992633ee62d5edfbb484d9c6bcb3cf158489d.zip
Migrate server to ESM
Sorry for the very big commit that may lead to git log issues and merge conflicts, but it's a major step forward: * Server can be faster at startup because imports() are async and we can easily lazy import big modules * Angular doesn't seem to support ES import (with .js extension), so we had to correctly organize peertube into a monorepo: * Use yarn workspace feature * Use typescript reference projects for dependencies * Shared projects have been moved into "packages", each one is now a node module (with a dedicated package.json/tsconfig.json) * server/tools have been moved into apps/ and is now a dedicated app bundled and published on NPM so users don't have to build peertube cli tools manually * server/tests have been moved into packages/ so we don't compile them every time we want to run the server * Use isolatedModule option: * Had to move from const enum to const (https://www.typescriptlang.org/docs/handbook/enums.html#objects-vs-enums) * Had to explictely specify "type" imports when used in decorators * Prefer tsx (that uses esbuild under the hood) instead of ts-node to load typescript files (tests with mocha or scripts): * To reduce test complexity as esbuild doesn't support decorator metadata, we only test server files that do not import server models * We still build tests files into js files for a faster CI * Remove unmaintained peertube CLI import script * Removed some barrels to speed up execution (less imports)
Diffstat (limited to 'scripts/prune-storage.ts')
-rwxr-xr-xscripts/prune-storage.ts184
1 files changed, 0 insertions, 184 deletions
diff --git a/scripts/prune-storage.ts b/scripts/prune-storage.ts
deleted file mode 100755
index 9a73a8600..000000000
--- a/scripts/prune-storage.ts
+++ /dev/null
@@ -1,184 +0,0 @@
1import { map } from 'bluebird'
2import { readdir, remove, stat } from 'fs-extra'
3import { basename, join } from 'path'
4import { get, start } from 'prompt'
5import { DIRECTORIES } from '@server/initializers/constants'
6import { VideoFileModel } from '@server/models/video/video-file'
7import { VideoStreamingPlaylistModel } from '@server/models/video/video-streaming-playlist'
8import { uniqify } from '@shared/core-utils'
9import { ThumbnailType } from '@shared/models'
10import { getUUIDFromFilename } from '../server/helpers/utils'
11import { CONFIG } from '../server/initializers/config'
12import { initDatabaseModels } from '../server/initializers/database'
13import { ActorImageModel } from '../server/models/actor/actor-image'
14import { VideoRedundancyModel } from '../server/models/redundancy/video-redundancy'
15import { ThumbnailModel } from '../server/models/video/thumbnail'
16import { VideoModel } from '../server/models/video/video'
17
18run()
19 .then(() => process.exit(0))
20 .catch(err => {
21 console.error(err)
22 process.exit(-1)
23 })
24
25async function run () {
26 const dirs = Object.values(CONFIG.STORAGE)
27
28 if (uniqify(dirs).length !== dirs.length) {
29 console.error('Cannot prune storage because you put multiple storage keys in the same directory.')
30 process.exit(0)
31 }
32
33 await initDatabaseModels(true)
34
35 let toDelete: string[] = []
36
37 console.log('Detecting files to remove, it could take a while...')
38
39 toDelete = toDelete.concat(
40 await pruneDirectory(DIRECTORIES.VIDEOS.PUBLIC, doesWebVideoFileExist()),
41 await pruneDirectory(DIRECTORIES.VIDEOS.PRIVATE, doesWebVideoFileExist()),
42
43 await pruneDirectory(DIRECTORIES.HLS_STREAMING_PLAYLIST.PRIVATE, doesHLSPlaylistExist()),
44 await pruneDirectory(DIRECTORIES.HLS_STREAMING_PLAYLIST.PUBLIC, doesHLSPlaylistExist()),
45
46 await pruneDirectory(CONFIG.STORAGE.TORRENTS_DIR, doesTorrentFileExist()),
47
48 await pruneDirectory(CONFIG.STORAGE.REDUNDANCY_DIR, doesRedundancyExist),
49
50 await pruneDirectory(CONFIG.STORAGE.PREVIEWS_DIR, doesThumbnailExist(true, ThumbnailType.PREVIEW)),
51 await pruneDirectory(CONFIG.STORAGE.THUMBNAILS_DIR, doesThumbnailExist(false, ThumbnailType.MINIATURE)),
52
53 await pruneDirectory(CONFIG.STORAGE.ACTOR_IMAGES_DIR, doesActorImageExist)
54 )
55
56 const tmpFiles = await readdir(CONFIG.STORAGE.TMP_DIR)
57 toDelete = toDelete.concat(tmpFiles.map(t => join(CONFIG.STORAGE.TMP_DIR, t)))
58
59 if (toDelete.length === 0) {
60 console.log('No files to delete.')
61 return
62 }
63
64 console.log('Will delete %d files:\n\n%s\n\n', toDelete.length, toDelete.join('\n'))
65
66 const res = await askConfirmation()
67 if (res === true) {
68 console.log('Processing delete...\n')
69
70 for (const path of toDelete) {
71 await remove(path)
72 }
73
74 console.log('Done!')
75 } else {
76 console.log('Exiting without deleting files.')
77 }
78}
79
80type ExistFun = (file: string) => Promise<boolean> | boolean
81async function pruneDirectory (directory: string, existFun: ExistFun) {
82 const files = await readdir(directory)
83
84 const toDelete: string[] = []
85 await map(files, async file => {
86 const filePath = join(directory, file)
87
88 if (await existFun(filePath) !== true) {
89 toDelete.push(filePath)
90 }
91 }, { concurrency: 20 })
92
93 return toDelete
94}
95
96function doesWebVideoFileExist () {
97 return (filePath: string) => {
98 // Don't delete private directory
99 if (filePath === DIRECTORIES.VIDEOS.PRIVATE) return true
100
101 return VideoFileModel.doesOwnedWebVideoFileExist(basename(filePath))
102 }
103}
104
105function doesHLSPlaylistExist () {
106 return (hlsPath: string) => {
107 // Don't delete private directory
108 if (hlsPath === DIRECTORIES.HLS_STREAMING_PLAYLIST.PRIVATE) return true
109
110 return VideoStreamingPlaylistModel.doesOwnedHLSPlaylistExist(basename(hlsPath))
111 }
112}
113
114function doesTorrentFileExist () {
115 return (filePath: string) => VideoFileModel.doesOwnedTorrentFileExist(basename(filePath))
116}
117
118function doesThumbnailExist (keepOnlyOwned: boolean, type: ThumbnailType) {
119 return async (filePath: string) => {
120 const thumbnail = await ThumbnailModel.loadByFilename(basename(filePath), type)
121 if (!thumbnail) return false
122
123 if (keepOnlyOwned) {
124 const video = await VideoModel.load(thumbnail.videoId)
125 if (video.isOwned() === false) return false
126 }
127
128 return true
129 }
130}
131
132async function doesActorImageExist (filePath: string) {
133 const image = await ActorImageModel.loadByName(basename(filePath))
134
135 return !!image
136}
137
138async function doesRedundancyExist (filePath: string) {
139 const isPlaylist = (await stat(filePath)).isDirectory()
140
141 if (isPlaylist) {
142 // Don't delete HLS redundancy directory
143 if (filePath === DIRECTORIES.HLS_REDUNDANCY) return true
144
145 const uuid = getUUIDFromFilename(filePath)
146 const video = await VideoModel.loadWithFiles(uuid)
147 if (!video) return false
148
149 const p = video.getHLSPlaylist()
150 if (!p) return false
151
152 const redundancy = await VideoRedundancyModel.loadLocalByStreamingPlaylistId(p.id)
153 return !!redundancy
154 }
155
156 const file = await VideoFileModel.loadByFilename(basename(filePath))
157 if (!file) return false
158
159 const redundancy = await VideoRedundancyModel.loadLocalByFileId(file.id)
160 return !!redundancy
161}
162
163async function askConfirmation () {
164 return new Promise((res, rej) => {
165 start()
166 const schema = {
167 properties: {
168 confirm: {
169 type: 'string',
170 description: 'These following unused files can be deleted, but please check your backups first (bugs happen).' +
171 ' Notice PeerTube must have been stopped when your ran this script.' +
172 ' Can we delete these files?',
173 default: 'n',
174 required: true
175 }
176 }
177 }
178 get(schema, function (err, result) {
179 if (err) return rej(err)
180
181 return res(result.confirm?.match(/y/) !== null)
182 })
183 })
184}