mirror of
https://github.com/Chocobozzz/PeerTube.git
synced 2025-10-04 02:09:37 +02:00
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)
This commit is contained in:
Chocobozzz
parent
04d1da5621
commit
3a4992633e
2196 changed files with 12690 additions and 11574 deletions
236
server/server/controllers/client.ts
Normal file
236
server/server/controllers/client.ts
Normal file
|
|
@ -0,0 +1,236 @@
|
|||
import express from 'express'
|
||||
import { constants, promises as fs } from 'fs'
|
||||
import { readFile } from 'fs/promises'
|
||||
import { join } from 'path'
|
||||
import { buildFileLocale, getCompleteLocale, is18nLocale, LOCALE_FILES } from '@peertube/peertube-core-utils'
|
||||
import { HttpStatusCode } from '@peertube/peertube-models'
|
||||
import { logger } from '@server/helpers/logger.js'
|
||||
import { CONFIG } from '@server/initializers/config.js'
|
||||
import { Hooks } from '@server/lib/plugins/hooks.js'
|
||||
import { currentDir, root } from '@peertube/peertube-node-utils'
|
||||
import { STATIC_MAX_AGE } from '../initializers/constants.js'
|
||||
import { ClientHtml, sendHTML, serveIndexHTML } from '../lib/client-html.js'
|
||||
import { asyncMiddleware, buildRateLimiter, embedCSP } from '../middlewares/index.js'
|
||||
|
||||
const clientsRouter = express.Router()
|
||||
|
||||
const clientsRateLimiter = buildRateLimiter({
|
||||
windowMs: CONFIG.RATES_LIMIT.CLIENT.WINDOW_MS,
|
||||
max: CONFIG.RATES_LIMIT.CLIENT.MAX
|
||||
})
|
||||
|
||||
const distPath = join(root(), 'client', 'dist')
|
||||
const testEmbedPath = join(distPath, 'standalone', 'videos', 'test-embed.html')
|
||||
|
||||
// Special route that add OpenGraph and oEmbed tags
|
||||
// Do not use a template engine for a so little thing
|
||||
clientsRouter.use([ '/w/p/:id', '/videos/watch/playlist/:id' ],
|
||||
clientsRateLimiter,
|
||||
asyncMiddleware(generateWatchPlaylistHtmlPage)
|
||||
)
|
||||
|
||||
clientsRouter.use([ '/w/:id', '/videos/watch/:id' ],
|
||||
clientsRateLimiter,
|
||||
asyncMiddleware(generateWatchHtmlPage)
|
||||
)
|
||||
|
||||
clientsRouter.use([ '/accounts/:nameWithHost', '/a/:nameWithHost' ],
|
||||
clientsRateLimiter,
|
||||
asyncMiddleware(generateAccountHtmlPage)
|
||||
)
|
||||
|
||||
clientsRouter.use([ '/video-channels/:nameWithHost', '/c/:nameWithHost' ],
|
||||
clientsRateLimiter,
|
||||
asyncMiddleware(generateVideoChannelHtmlPage)
|
||||
)
|
||||
|
||||
clientsRouter.use('/@:nameWithHost',
|
||||
clientsRateLimiter,
|
||||
asyncMiddleware(generateActorHtmlPage)
|
||||
)
|
||||
|
||||
const embedMiddlewares = [
|
||||
clientsRateLimiter,
|
||||
|
||||
CONFIG.CSP.ENABLED
|
||||
? embedCSP
|
||||
: (req: express.Request, res: express.Response, next: express.NextFunction) => next(),
|
||||
|
||||
// Set headers
|
||||
(req: express.Request, res: express.Response, next: express.NextFunction) => {
|
||||
res.removeHeader('X-Frame-Options')
|
||||
|
||||
// Don't cache HTML file since it's an index to the immutable JS/CSS files
|
||||
res.setHeader('Cache-Control', 'public, max-age=0')
|
||||
|
||||
next()
|
||||
},
|
||||
|
||||
asyncMiddleware(generateEmbedHtmlPage)
|
||||
]
|
||||
|
||||
clientsRouter.use('/videos/embed', ...embedMiddlewares)
|
||||
clientsRouter.use('/video-playlists/embed', ...embedMiddlewares)
|
||||
|
||||
const testEmbedController = (req: express.Request, res: express.Response) => res.sendFile(testEmbedPath)
|
||||
|
||||
clientsRouter.use('/videos/test-embed', clientsRateLimiter, testEmbedController)
|
||||
clientsRouter.use('/video-playlists/test-embed', clientsRateLimiter, testEmbedController)
|
||||
|
||||
// Dynamic PWA manifest
|
||||
clientsRouter.get('/manifest.webmanifest', clientsRateLimiter, asyncMiddleware(generateManifest))
|
||||
|
||||
// Static client overrides
|
||||
// Must be consistent with static client overrides redirections in /support/nginx/peertube
|
||||
const staticClientOverrides = [
|
||||
'assets/images/logo.svg',
|
||||
'assets/images/favicon.png',
|
||||
'assets/images/icons/icon-36x36.png',
|
||||
'assets/images/icons/icon-48x48.png',
|
||||
'assets/images/icons/icon-72x72.png',
|
||||
'assets/images/icons/icon-96x96.png',
|
||||
'assets/images/icons/icon-144x144.png',
|
||||
'assets/images/icons/icon-192x192.png',
|
||||
'assets/images/icons/icon-512x512.png',
|
||||
'assets/images/default-playlist.jpg',
|
||||
'assets/images/default-avatar-account.png',
|
||||
'assets/images/default-avatar-account-48x48.png',
|
||||
'assets/images/default-avatar-video-channel.png',
|
||||
'assets/images/default-avatar-video-channel-48x48.png'
|
||||
]
|
||||
|
||||
for (const staticClientOverride of staticClientOverrides) {
|
||||
const overridePhysicalPath = join(CONFIG.STORAGE.CLIENT_OVERRIDES_DIR, staticClientOverride)
|
||||
clientsRouter.use(`/client/${staticClientOverride}`, asyncMiddleware(serveClientOverride(overridePhysicalPath)))
|
||||
}
|
||||
|
||||
clientsRouter.use('/client/locales/:locale/:file.json', serveServerTranslations)
|
||||
clientsRouter.use('/client', express.static(distPath, { maxAge: STATIC_MAX_AGE.CLIENT }))
|
||||
|
||||
// 404 for static files not found
|
||||
clientsRouter.use('/client/*', (req: express.Request, res: express.Response) => {
|
||||
res.status(HttpStatusCode.NOT_FOUND_404).end()
|
||||
})
|
||||
|
||||
// Always serve index client page (the client is a single page application, let it handle routing)
|
||||
// Try to provide the right language index.html
|
||||
clientsRouter.use('/(:language)?',
|
||||
clientsRateLimiter,
|
||||
asyncMiddleware(serveIndexHTML)
|
||||
)
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
export {
|
||||
clientsRouter
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
function serveServerTranslations (req: express.Request, res: express.Response) {
|
||||
const locale = req.params.locale
|
||||
const file = req.params.file
|
||||
|
||||
if (is18nLocale(locale) && LOCALE_FILES.includes(file)) {
|
||||
const completeLocale = getCompleteLocale(locale)
|
||||
const completeFileLocale = buildFileLocale(completeLocale)
|
||||
|
||||
const path = join(currentDir(import.meta.url), `../../../client/dist/locale/${file}.${completeFileLocale}.json`)
|
||||
return res.sendFile(path, { maxAge: STATIC_MAX_AGE.SERVER })
|
||||
}
|
||||
|
||||
return res.status(HttpStatusCode.NOT_FOUND_404).end()
|
||||
}
|
||||
|
||||
async function generateEmbedHtmlPage (req: express.Request, res: express.Response) {
|
||||
const hookName = req.originalUrl.startsWith('/video-playlists/')
|
||||
? 'filter:html.embed.video-playlist.allowed.result'
|
||||
: 'filter:html.embed.video.allowed.result'
|
||||
|
||||
const allowParameters = { req }
|
||||
|
||||
const allowedResult = await Hooks.wrapFun(
|
||||
isEmbedAllowed,
|
||||
allowParameters,
|
||||
hookName
|
||||
)
|
||||
|
||||
if (!allowedResult || allowedResult.allowed !== true) {
|
||||
logger.info('Embed is not allowed.', { allowedResult })
|
||||
|
||||
return sendHTML(allowedResult?.html || '', res)
|
||||
}
|
||||
|
||||
const html = await ClientHtml.getEmbedHTML()
|
||||
|
||||
return sendHTML(html, res)
|
||||
}
|
||||
|
||||
async function generateWatchHtmlPage (req: express.Request, res: express.Response) {
|
||||
// Thread link is '/w/:videoId;threadId=:threadId'
|
||||
// So to get the videoId we need to remove the last part
|
||||
let videoId = req.params.id + ''
|
||||
|
||||
const threadIdIndex = videoId.indexOf(';threadId')
|
||||
if (threadIdIndex !== -1) videoId = videoId.substring(0, threadIdIndex)
|
||||
|
||||
const html = await ClientHtml.getWatchHTMLPage(videoId, req, res)
|
||||
|
||||
return sendHTML(html, res, true)
|
||||
}
|
||||
|
||||
async function generateWatchPlaylistHtmlPage (req: express.Request, res: express.Response) {
|
||||
const html = await ClientHtml.getWatchPlaylistHTMLPage(req.params.id + '', req, res)
|
||||
|
||||
return sendHTML(html, res, true)
|
||||
}
|
||||
|
||||
async function generateAccountHtmlPage (req: express.Request, res: express.Response) {
|
||||
const html = await ClientHtml.getAccountHTMLPage(req.params.nameWithHost, req, res)
|
||||
|
||||
return sendHTML(html, res, true)
|
||||
}
|
||||
|
||||
async function generateVideoChannelHtmlPage (req: express.Request, res: express.Response) {
|
||||
const html = await ClientHtml.getVideoChannelHTMLPage(req.params.nameWithHost, req, res)
|
||||
|
||||
return sendHTML(html, res, true)
|
||||
}
|
||||
|
||||
async function generateActorHtmlPage (req: express.Request, res: express.Response) {
|
||||
const html = await ClientHtml.getActorHTMLPage(req.params.nameWithHost, req, res)
|
||||
|
||||
return sendHTML(html, res, true)
|
||||
}
|
||||
|
||||
async function generateManifest (req: express.Request, res: express.Response) {
|
||||
const manifestPhysicalPath = join(root(), 'client', 'dist', 'manifest.webmanifest')
|
||||
const manifestJson = await readFile(manifestPhysicalPath, 'utf8')
|
||||
const manifest = JSON.parse(manifestJson)
|
||||
|
||||
manifest.name = CONFIG.INSTANCE.NAME
|
||||
manifest.short_name = CONFIG.INSTANCE.NAME
|
||||
manifest.description = CONFIG.INSTANCE.SHORT_DESCRIPTION
|
||||
|
||||
res.json(manifest)
|
||||
}
|
||||
|
||||
function serveClientOverride (path: string) {
|
||||
return async (req: express.Request, res: express.Response, next: express.NextFunction) => {
|
||||
try {
|
||||
await fs.access(path, constants.F_OK)
|
||||
// Serve override client
|
||||
res.sendFile(path, { maxAge: STATIC_MAX_AGE.SERVER })
|
||||
} catch {
|
||||
// Serve dist client
|
||||
next()
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
type AllowedResult = { allowed: boolean, html?: string }
|
||||
function isEmbedAllowed (_object: {
|
||||
req: express.Request
|
||||
}): AllowedResult {
|
||||
return { allowed: true }
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue