aboutsummaryrefslogtreecommitdiffhomepage
path: root/server/initializers/checker-before-init.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 /server/initializers/checker-before-init.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 'server/initializers/checker-before-init.ts')
-rw-r--r--server/initializers/checker-before-init.ts162
1 files changed, 0 insertions, 162 deletions
diff --git a/server/initializers/checker-before-init.ts b/server/initializers/checker-before-init.ts
deleted file mode 100644
index 0139ded4f..000000000
--- a/server/initializers/checker-before-init.ts
+++ /dev/null
@@ -1,162 +0,0 @@
1import { IConfig } from 'config'
2import { promisify0 } from '@shared/core-utils'
3import { parseSemVersion } from '../helpers/core-utils'
4import { logger } from '../helpers/logger'
5
6// Special behaviour for config because we can reload it
7const config: IConfig = require('config')
8
9// ONLY USE CORE MODULES IN THIS FILE!
10
11// Check the config files
12function checkMissedConfig () {
13 const required = [ 'listen.port', 'listen.hostname',
14 'webserver.https', 'webserver.hostname', 'webserver.port',
15 'secrets.peertube',
16 'trust_proxy',
17 'oauth2.token_lifetime.access_token', 'oauth2.token_lifetime.refresh_token',
18 'database.hostname', 'database.port', 'database.username', 'database.password', 'database.pool.max',
19 'smtp.hostname', 'smtp.port', 'smtp.username', 'smtp.password', 'smtp.tls', 'smtp.from_address',
20 'email.body.signature', 'email.subject.prefix',
21 'storage.avatars', 'storage.web_videos', 'storage.logs', 'storage.previews', 'storage.thumbnails', 'storage.torrents', 'storage.cache',
22 'storage.redundancy', 'storage.tmp', 'storage.streaming_playlists', 'storage.plugins', 'storage.well_known',
23 'log.level', 'log.rotation.enabled', 'log.rotation.max_file_size', 'log.rotation.max_files', 'log.anonymize_ip',
24 'log.log_ping_requests', 'log.log_tracker_unknown_infohash', 'log.prettify_sql', 'log.accept_client_log',
25 'open_telemetry.metrics.enabled', 'open_telemetry.metrics.prometheus_exporter.hostname',
26 'open_telemetry.metrics.prometheus_exporter.port', 'open_telemetry.tracing.enabled', 'open_telemetry.tracing.jaeger_exporter.endpoint',
27 'open_telemetry.metrics.http_request_duration.enabled',
28 'user.history.videos.enabled', 'user.video_quota', 'user.video_quota_daily',
29 'video_channels.max_per_user',
30 'csp.enabled', 'csp.report_only', 'csp.report_uri',
31 'security.frameguard.enabled', 'security.powered_by_header.enabled',
32 'cache.previews.size', 'cache.captions.size', 'cache.torrents.size', 'cache.storyboards.size',
33 'admin.email', 'contact_form.enabled',
34 'signup.enabled', 'signup.limit', 'signup.requires_approval', 'signup.requires_email_verification', 'signup.minimum_age',
35 'signup.filters.cidr.whitelist', 'signup.filters.cidr.blacklist',
36 'redundancy.videos.strategies', 'redundancy.videos.check_interval',
37 'transcoding.enabled', 'transcoding.threads', 'transcoding.allow_additional_extensions', 'transcoding.web_videos.enabled',
38 'transcoding.hls.enabled', 'transcoding.profile', 'transcoding.concurrency',
39 'transcoding.resolutions.0p', 'transcoding.resolutions.144p', 'transcoding.resolutions.240p', 'transcoding.resolutions.360p',
40 'transcoding.resolutions.480p', 'transcoding.resolutions.720p', 'transcoding.resolutions.1080p', 'transcoding.resolutions.1440p',
41 'transcoding.resolutions.2160p', 'transcoding.always_transcode_original_resolution', 'transcoding.remote_runners.enabled',
42 'video_studio.enabled', 'video_studio.remote_runners.enabled',
43 'video_file.update.enabled',
44 'remote_runners.stalled_jobs.vod', 'remote_runners.stalled_jobs.live',
45 'import.videos.http.enabled', 'import.videos.torrent.enabled', 'import.videos.concurrency', 'import.videos.timeout',
46 'import.video_channel_synchronization.enabled', 'import.video_channel_synchronization.max_per_user',
47 'import.video_channel_synchronization.check_interval', 'import.video_channel_synchronization.videos_limit_per_synchronization',
48 'import.video_channel_synchronization.full_sync_videos_limit',
49 'auto_blacklist.videos.of_users.enabled', 'trending.videos.interval_days',
50 'client.videos.miniature.display_author_avatar',
51 'client.videos.miniature.prefer_author_display_name', 'client.menu.login.redirect_on_single_external_auth',
52 'defaults.publish.download_enabled', 'defaults.publish.comments_enabled', 'defaults.publish.privacy', 'defaults.publish.licence',
53 'instance.name', 'instance.short_description', 'instance.description', 'instance.terms', 'instance.default_client_route',
54 'instance.is_nsfw', 'instance.default_nsfw_policy', 'instance.robots', 'instance.securitytxt',
55 'services.twitter.username', 'services.twitter.whitelisted',
56 'followers.instance.enabled', 'followers.instance.manual_approval',
57 'tracker.enabled', 'tracker.private', 'tracker.reject_too_many_announces',
58 'history.videos.max_age', 'views.videos.remote.max_age', 'views.videos.local_buffer_update_interval', 'views.videos.ip_view_expiration',
59 'rates_limit.api.window', 'rates_limit.api.max', 'rates_limit.login.window', 'rates_limit.login.max',
60 'rates_limit.signup.window', 'rates_limit.signup.max', 'rates_limit.ask_send_email.window', 'rates_limit.ask_send_email.max',
61 'rates_limit.receive_client_log.window', 'rates_limit.receive_client_log.max', 'rates_limit.plugins.window', 'rates_limit.plugins.max',
62 'rates_limit.well_known.window', 'rates_limit.well_known.max', 'rates_limit.feeds.window', 'rates_limit.feeds.max',
63 'rates_limit.activity_pub.window', 'rates_limit.activity_pub.max', 'rates_limit.client.window', 'rates_limit.client.max',
64 'static_files.private_files_require_auth',
65 'object_storage.enabled', 'object_storage.endpoint', 'object_storage.region', 'object_storage.upload_acl.public',
66 'object_storage.upload_acl.private', 'object_storage.proxy.proxify_private_files', 'object_storage.credentials.access_key_id',
67 'object_storage.credentials.secret_access_key', 'object_storage.max_upload_part', 'object_storage.streaming_playlists.bucket_name',
68 'object_storage.streaming_playlists.prefix', 'object_storage.streaming_playlists.base_url', 'object_storage.web_videos.bucket_name',
69 'object_storage.web_videos.prefix', 'object_storage.web_videos.base_url',
70 'theme.default',
71 'feeds.videos.count', 'feeds.comments.count',
72 'geo_ip.enabled', 'geo_ip.country.database_url',
73 'remote_redundancy.videos.accept_from',
74 'federation.videos.federate_unlisted', 'federation.videos.cleanup_remote_interactions',
75 'peertube.check_latest_version.enabled', 'peertube.check_latest_version.url',
76 'search.remote_uri.users', 'search.remote_uri.anonymous', 'search.search_index.enabled', 'search.search_index.url',
77 'search.search_index.disable_local_search', 'search.search_index.is_default_search',
78 'live.enabled', 'live.allow_replay', 'live.latency_setting.enabled', 'live.max_duration',
79 'live.max_user_lives', 'live.max_instance_lives',
80 'live.rtmp.enabled', 'live.rtmp.port', 'live.rtmp.hostname', 'live.rtmp.public_hostname',
81 'live.rtmps.enabled', 'live.rtmps.port', 'live.rtmps.hostname', 'live.rtmps.public_hostname',
82 'live.rtmps.key_file', 'live.rtmps.cert_file',
83 'live.transcoding.enabled', 'live.transcoding.threads', 'live.transcoding.profile',
84 'live.transcoding.resolutions.144p', 'live.transcoding.resolutions.240p', 'live.transcoding.resolutions.360p',
85 'live.transcoding.resolutions.480p', 'live.transcoding.resolutions.720p', 'live.transcoding.resolutions.1080p',
86 'live.transcoding.resolutions.1440p', 'live.transcoding.resolutions.2160p', 'live.transcoding.always_transcode_original_resolution',
87 'live.transcoding.remote_runners.enabled'
88 ]
89
90 const requiredAlternatives = [
91 [ // set
92 [ 'redis.hostname', 'redis.port' ], // alternative
93 [ 'redis.socket' ],
94 [ 'redis.sentinel.master_name', 'redis.sentinel.sentinels[0].hostname', 'redis.sentinel.sentinels[0].port' ]
95 ]
96 ]
97 const miss: string[] = []
98
99 for (const key of required) {
100 if (!config.has(key)) {
101 miss.push(key)
102 }
103 }
104
105 const redundancyVideos = config.get<any>('redundancy.videos.strategies')
106
107 if (Array.isArray(redundancyVideos)) {
108 for (const r of redundancyVideos) {
109 if (!r.size) miss.push('redundancy.videos.strategies.size')
110 if (!r.min_lifetime) miss.push('redundancy.videos.strategies.min_lifetime')
111 }
112 }
113
114 const missingAlternatives = requiredAlternatives.filter(
115 set => !set.find(alternative => !alternative.find(key => !config.has(key)))
116 )
117
118 missingAlternatives
119 .forEach(set => set[0].forEach(key => miss.push(key)))
120
121 return miss
122}
123
124// Check the available codecs
125// We get CONFIG by param to not import it in this file (import orders)
126async function checkFFmpeg (CONFIG: { TRANSCODING: { ENABLED: boolean } }) {
127 if (CONFIG.TRANSCODING.ENABLED === false) return undefined
128
129 const Ffmpeg = require('fluent-ffmpeg')
130 const getAvailableCodecsPromise = promisify0(Ffmpeg.getAvailableCodecs)
131 const codecs = await getAvailableCodecsPromise()
132 const canEncode = [ 'libx264' ]
133
134 for (const codec of canEncode) {
135 if (codecs[codec] === undefined) {
136 throw new Error('Unknown codec ' + codec + ' in FFmpeg.')
137 }
138
139 if (codecs[codec].canEncode !== true) {
140 throw new Error('Unavailable encode codec ' + codec + ' in FFmpeg')
141 }
142 }
143}
144
145function checkNodeVersion () {
146 const v = process.version
147 const { major } = parseSemVersion(v)
148
149 logger.debug('Checking NodeJS version %s.', v)
150
151 if (major <= 12) {
152 throw new Error('Your NodeJS version ' + v + ' is not supported. Please upgrade.')
153 }
154}
155
156// ---------------------------------------------------------------------------
157
158export {
159 checkFFmpeg,
160 checkMissedConfig,
161 checkNodeVersion
162}